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:51:51 UTC
[01/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Repository: usergrid
Updated Branches:
refs/heads/master d2061dc3d -> ae39eca6a
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridClient.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridClient.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridClient.html
deleted file mode 100644
index 0b1b378..0000000
--- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridClient.html
+++ /dev/null
@@ -1,3800 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridClient 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/UsergridClient" class="dashAnchor"></a>
- <a title="UsergridClient 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" />
- UsergridClient 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>UsergridClient</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p>The <code>UsergridClient</code> class is the base handler for making client connections to and managing relationships with Usergrid’s API.</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:vC11UsergridSDK14UsergridClient6configCS_20UsergridClientConfig"></a>
- <a name="//apple_ref/swift/Property/config" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient6configCS_20UsergridClientConfig">config</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The configuration object used by the client.</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">config</span><span class="p">:</span> <span class="kt">UsergridClientConfig</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient5appIdSS"></a>
- <a name="//apple_ref/swift/Property/appId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient5appIdSS">appId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application identifier.</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">appId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">appId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient5orgIdSS"></a>
- <a name="//apple_ref/swift/Property/orgId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient5orgIdSS">orgId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The organization identifier.</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">orgId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">orgId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient7baseUrlSS"></a>
- <a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient7baseUrlSS">baseUrl</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The base URL that all calls will be made with.</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">baseUrl</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">baseUrl</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient28persistCurrentUserInKeychainSb"></a>
- <a name="//apple_ref/swift/Property/persistCurrentUserInKeychain" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Whether or not the current user will be saved and restored from the keychain.</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">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_"></a>
- <a name="//apple_ref/swift/Property/currentUser" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">currentUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The currently logged in <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">currentUser</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient8userAuthGSqCS_16UsergridUserAuth_"></a>
- <a name="//apple_ref/swift/Property/userAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient8userAuthGSqCS_16UsergridUserAuth_">userAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> which consists of the token information from the <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">currentUser</a></code> property.</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">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">currentUser</span><span class="p">?</span><span class="o">.</span><span class="n">auth</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_"></a>
- <a name="//apple_ref/swift/Property/appAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_">appAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application level <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object. Can be set manually but must call <code>authenticateApp</code> to retrive token.</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">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient12authFallbackOS_20UsergridAuthFallback"></a>
- <a name="//apple_ref/swift/Property/authFallback" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient12authFallbackOS_20UsergridAuthFallback">authFallback</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Enums/UsergridAuthFallback.html">UsergridAuthFallback</a></code> value used to determine what type of token will be sent, if any.</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">authFallback</span><span class="p">:</span> <span class="kt">UsergridAuthFallback</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:FC11UsergridSDK14UsergridClientcFMS0_FT5orgIdSS5appIdSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFMS0_FT5orgIdSS5appIdSS_S0_">init(orgId:appId:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes instances of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</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>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClientcFMS0_FT5orgIdSS5appIdSS7baseUrlSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:baseUrl:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFMS0_FT5orgIdSS5appIdSS7baseUrlSS_S0_">init(orgId:appId:baseUrl:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes instances of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">baseUrl</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>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>baseUrl</em>
- </code>
- </td>
- <td>
- <div>
- <p>The base URL that all calls will be made with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClientcFMS0_FT13configurationCS_20UsergridClientConfig_S0_"></a>
- <a name="//apple_ref/swift/Method/init(configuration:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFMS0_FT13configurationCS_20UsergridClientConfig_S0_">init(configuration:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes instances of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">configuration</span><span class="p">:</span><span class="kt">UsergridClientConfig</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>configuration</em>
- </code>
- </td>
- <td>
- <div>
- <p>The configuration for the client to be set up with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</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:FC11UsergridSDK14UsergridClientcFMS0_FT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFMS0_FT5coderCSo7NSCoder_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">public</span> <span class="kd">required</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/UsergridClient.html">UsergridClient</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15encodeWithCoderFS0_FCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15encodeWithCoderFS0_FCSo7NSCoderT_">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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Device%20Registration/Push%20Notifications"></a>
- <a name="//apple_ref/swift/Section/Device Registration/Push Notifications" class="dashAnchor"></a>
- <a href="#/Device%20Registration/Push%20Notifications">
- <h3 class="section-name">Device Registration/Push Notifications</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient14applyPushTokenFS0_FTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient14applyPushTokenFS0_FTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the shared <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance.</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">applyPushToken</span><span class="p">(</span><span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient14applyPushTokenFS0_FTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:pushToken:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient14applyPushTokenFS0_FTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:pushToken:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the given <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance.</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">applyPushToken</span><span class="p">(</span><span class="nv">device</span><span class="p">:</span> <span class="kt">UsergridDevice</span><span class="p">,</span> <span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>device</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridDevice</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Authorization%20and%20User%20Management"></a>
- <a name="//apple_ref/swift/Section/Authorization and User Management" class="dashAnchor"></a>
- <a href="#/Authorization%20and%20User%20Management">
- <h3 class="section-name">Authorization and User Management</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient9usingAuthFS0_FCS_12UsergridAuthDS0_"></a>
- <a name="//apple_ref/swift/Method/usingAuth(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient9usingAuthFS0_FCS_12UsergridAuthDS0_">usingAuth(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the client’s <code>tempAuth</code> property using the passed in <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code>.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">usingAuth</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="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAuth</code> object to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient10usingTokenFS0_FSSDS0_"></a>
- <a name="//apple_ref/swift/Method/usingToken(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10usingTokenFS0_FSSDS0_">usingToken(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the client’s <code>tempAuth</code> property using the passed in token.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">usingToken</span><span class="p">(</span><span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The access token to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is contained this instance of <code>UsergridCient</code>.</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">authenticateApp</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is passed in.</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">authenticateApp</span><span class="p">(</span><span class="nv">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAppAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in.</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">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:setAsCurrentUser:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:setAsCurrentUser:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in.</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">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">setAsCurrentUser</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>setAsCurrentUser</em>
- </code>
- </td>
- <td>
- <div>
- <p>If the authenticated user should be set as the <code>UsergridClient.currentUser</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient13resetPasswordFS0_FTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a>
- <a name="//apple_ref/swift/Method/resetPassword(_:old:new:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient13resetPasswordFS0_FTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:old:new:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Changes the give <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">resetPassword</span><span class="p">(</span><span class="nv">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">,</span> <span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserResetPasswordCompletion</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>user</em>
- </code>
- </td>
- <td>
- <div>
- <p>The user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>old</em>
- </code>
- </td>
- <td>
- <div>
- <p>The old password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>new</em>
- </code>
- </td>
- <td>
- <div>
- <p>The new password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFS0_FTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFS0_FTGSqFT8responseCS_16UsergridResponse_T___T_">logoutCurrentUser(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the current user locally and remotely.</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">logoutCurrentUser</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUserAllTokens(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUserAllTokens(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the user remotely with the given tokens.</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">logoutUserAllTokens</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient10logoutUserFS0_FTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUser(_:token:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10logoutUserFS0_FTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUser(_:token:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out a user with the give UUID or username using the shared instance of <code>UsergridCient</code>.</p>
-
-<p>Passing in a token will log out the user for just that token. Passing in nil for the token will logout the user for all tokens.</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">logoutUser</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Generic%20Request%20Methods"></a>
- <a name="//apple_ref/swift/Section/Generic Request Methods" class="dashAnchor"></a>
- <a href="#/Generic%20Request%20Methods">
- <h3 class="section-name">Generic Request Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient11sendRequestFS0_FTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/sendRequest(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient11sendRequestFS0_FTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_">sendRequest(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Starts the <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> sending process.</p>
-
-<div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>This method should only be used when you construct your own <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> objects.</p>
-
-</div>
-
- </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">sendRequest</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span><span class="kt">UsergridRequest</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>request</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridRequest</code> object to send.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/GET"></a>
- <a name="//apple_ref/swift/Section/GET" class="dashAnchor"></a>
- <a href="#/GET">
- <h3 class="section-name">GET</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:uuidOrName:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:uuidOrName:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a single <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> of a given type with a specific UUID/name.</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="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>uuidOrName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The UUID or name of the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a group of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects of a given type.</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="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
-
<TRUNCATED>
[16/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery/UsergridQueryOperator.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery/UsergridQueryOperator.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery/UsergridQueryOperator.html
deleted file mode 100644
index 0b518b1..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery/UsergridQueryOperator.html
+++ /dev/null
@@ -1,272 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridQueryOperator Enum 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/Enum/UsergridQueryOperator" class="dashAnchor"></a>
- <a title="UsergridQueryOperator Enum Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../../index.html"> Docs</a> (51% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../../index.html"> Reference</a>
- <img id="carat" src="../../img/carat.png" />
- UsergridQueryOperator Enum 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/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/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/UsergridResponse.html">UsergridResponse</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="../../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridQueryOperator</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator5EqualFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Equal" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator5EqualFMS1_S1_">Equal</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator11GreaterThanFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/GreaterThan" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator11GreaterThanFMS1_S1_">GreaterThan</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator18GreaterThanEqualToFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/GreaterThanEqualTo" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator18GreaterThanEqualToFMS1_S1_">GreaterThanEqualTo</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator8LessThanFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/LessThan" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator8LessThanFMS1_S1_">LessThan</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator15LessThanEqualToFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/LessThanEqualTo" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator15LessThanEqualToFMS1_S1_">LessThanEqualTo</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFOC11UsergridSDK13UsergridQuery21UsergridQueryOperator10fromStringFMS1_FSSGSqS1__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFOC11UsergridSDK13UsergridQuery21UsergridQueryOperator10fromStringFMS1_FSSGSqS1__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vOC11UsergridSDK13UsergridQuery21UsergridQueryOperator11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vOC11UsergridSDK13UsergridQuery21UsergridQueryOperator11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-21)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/UsergridQuery/UsergridQuerySortOrder.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery/UsergridQuerySortOrder.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery/UsergridQuerySortOrder.html
deleted file mode 100644
index afe97c4..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery/UsergridQuerySortOrder.html
+++ /dev/null
@@ -1,203 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridQuerySortOrder Enum 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/Enum/UsergridQuerySortOrder" class="dashAnchor"></a>
- <a title="UsergridQuerySortOrder Enum Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../../index.html"> Docs</a> (51% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../../index.html"> Reference</a>
- <img id="carat" src="../../img/carat.png" />
- UsergridQuerySortOrder Enum 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/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/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/UsergridResponse.html">UsergridResponse</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="../../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridQuerySortOrder</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder3AscFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Asc" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder3AscFMS1_S1_">Asc</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder4DescFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Desc" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder4DescFMS1_S1_">Desc</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder10fromStringFMS1_FSSGSqS1__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder10fromStringFMS1_FSSGSqS1__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-21)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/UsergridRequest.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridRequest.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridRequest.html
deleted file mode 100644
index 0405ff5..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridRequest.html
+++ /dev/null
@@ -1,619 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridRequest 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/UsergridRequest" class="dashAnchor"></a>
- <a title="UsergridRequest 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" />
- UsergridRequest 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>UsergridRequest</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridRequest</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p>The UsergridRequest class incapsulates the properties that all requests made by the SDK have in common. </p>
-
-<p>This class is also functions to create <code>NSURLRequest</code> objects based on the properties of the class.</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:vC11UsergridSDK15UsergridRequest6methodOS_18UsergridHttpMethod"></a>
- <a name="//apple_ref/swift/Property/method" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest6methodOS_18UsergridHttpMethod">method</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The HTTP method.</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">method</span><span class="p">:</span> <span class="kt">UsergridHttpMethod</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK15UsergridRequest7baseUrlSS"></a>
- <a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest7baseUrlSS">baseUrl</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The base URL.</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">baseUrl</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:vC11UsergridSDK15UsergridRequest5pathsGSqGSaSS__"></a>
- <a name="//apple_ref/swift/Property/paths" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest5pathsGSqGSaSS__">paths</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The paths to append to the base URL.</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">paths</span><span class="p">:</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:vC11UsergridSDK15UsergridRequest5queryGSqCS_13UsergridQuery_"></a>
- <a name="//apple_ref/swift/Property/query" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest5queryGSqCS_13UsergridQuery_">query</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The query to append to the URL.</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">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK15UsergridRequest4authGSqCS_12UsergridAuth_"></a>
- <a name="//apple_ref/swift/Property/auth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest4authGSqCS_12UsergridAuth_">auth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The auth that will be used.</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">auth</span><span class="p">:</span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK15UsergridRequest7headersGSqGVs10DictionarySSSS__"></a>
- <a name="//apple_ref/swift/Property/headers" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest7headersGSqGVs10DictionarySSSS__">headers</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The headers to add to the 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">headers</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</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:vC11UsergridSDK15UsergridRequest8jsonBodyGSqPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Property/jsonBody" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest8jsonBodyGSqPs9AnyObject__">jsonBody</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The JSON body that will be set on the request. Can be either a valid JSON object or NSData.</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">jsonBody</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK15UsergridRequest11queryParamsGSqGVs10DictionarySSSS__"></a>
- <a name="//apple_ref/swift/Property/queryParams" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest11queryParamsGSqGVs10DictionarySSSS__">queryParams</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The query params that will be set on the 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">queryParams</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</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:FC11UsergridSDK15UsergridRequestcFT6methodOS_18UsergridHttpMethod7baseUrlSS5pathsGSqGSaSS__5queryGSqCS_13UsergridQuery_4authGSqCS_12UsergridAuth_7headersGSqGVs10DictionarySSSS__8jsonBodyGSqPs9AnyObject__11queryParamsGSqGS4_SSSS___S0_"></a>
- <a name="//apple_ref/swift/Method/init(method:baseUrl:paths:query:auth:headers:jsonBody:queryParams:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK15UsergridRequestcFT6methodOS_18UsergridHttpMethod7baseUrlSS5pathsGSqGSaSS__5queryGSqCS_13UsergridQuery_4authGSqCS_12UsergridAuth_7headersGSqGVs10DictionarySSSS__8jsonBodyGSqPs9AnyObject__11queryParamsGSqGS4_SSSS___S0_">init(method:baseUrl:paths:query:auth:headers:jsonBody:queryParams:)</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/UsergridRequest.html">UsergridRequest</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">method</span><span class="p">:</span><span class="kt">UsergridHttpMethod</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">query</span><span class="p">:</span><span class="kt">UsergridQuery</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="nv">headers</span><span class="p">:[</span><span class="kt">String</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">jsonBody</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">queryParams</span><span class="p">:[</span><span class="kt">String</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>method</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP method.</p>
-
- </div>
- </td>
- </tr>
- <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>query</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional query to append to the 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>headers</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional headers.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional JSON body. Can be either a valid JSON object or NSData.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>queryParams</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional query params to be appended to the request url.</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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Instance%20Methods"></a>
- <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
- <a href="#/Instance%20Methods">
- <h3 class="section-name">Instance Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK15UsergridRequest17buildNSURLRequestFT_CSo12NSURLRequest"></a>
- <a name="//apple_ref/swift/Method/buildNSURLRequest()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK15UsergridRequest17buildNSURLRequestFT_CSo12NSURLRequest">buildNSURLRequest()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Constructs a <code>NSURLRequest</code> object with this objects instance properties.</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">buildNSURLRequest</span><span class="p">()</span> <span class="o">-></span> <span class="kt">NSURLRequest</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>An initialized and configured <code>NSURLRequest</code> object.</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>
[14/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser.html
deleted file mode 100644
index aa93547..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser.html
+++ /dev/null
@@ -1,2434 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridUser 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/UsergridUser" class="dashAnchor"></a>
- <a title="UsergridUser 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" />
- UsergridUser 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>UsergridUser</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridUser</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridUser</code> is a special subclass of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> that supports functions and properties unique to users.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:iC11UsergridSDK12UsergridUser9subscriptFSSGSqPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:iC11UsergridSDK12UsergridUser9subscriptFSSGSqPs9AnyObject__">subscript(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Subscript for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> class.</p>
-
-<div class="aside aside-warning">
- <p class="aside-title">Warning</p>
- <p>When setting a properties value must be a valid JSON object.</p>
-
-</div>
-
-<p><li><p>Example usage:
-“`
-let someName = usergridUser[<q>name</q>]</p></li></p>
-
-<p>usergridUser[<q>name</q>] = someName
-”`</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="nf">subscript</span><span class="p">(</span><span class="nv">propertyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AnyObject</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="/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:vC11UsergridSDK12UsergridUser4authGSqCS_16UsergridUserAuth_"></a>
- <a name="//apple_ref/swift/Property/auth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser4authGSqCS_16UsergridUserAuth_">auth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> object if this user was authenticated.</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">auth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridUser4nameGSqSS_"></a>
- <a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser4nameGSqSS_">name</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties4NameFMS0_S0_">UsergridUserProperties.Name</a></code>.</p>
-
-<p>Unlike <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects, <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s can change their name property which is why we provide a getter here.</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="k">var</span> <span class="nv">name</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:vC11UsergridSDK12UsergridUser8usernameGSqSS_"></a>
- <a name="//apple_ref/swift/Property/username" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser8usernameGSqSS_">username</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties8UsernameFMS0_S0_">UsergridUserProperties.Username</a></code>.</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">username</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:vC11UsergridSDK12UsergridUser8passwordGSqSS_"></a>
- <a name="//apple_ref/swift/Property/password" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser8passwordGSqSS_">password</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties8PasswordFMS0_S0_">UsergridUserProperties.Password</a></code>.</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">password</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:vC11UsergridSDK12UsergridUser5emailGSqSS_"></a>
- <a name="//apple_ref/swift/Property/email" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser5emailGSqSS_">email</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties5EmailFMS0_S0_">UsergridUserProperties.Email</a></code>.</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">email</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:vC11UsergridSDK12UsergridUser3ageGSqCSo8NSNumber_"></a>
- <a name="//apple_ref/swift/Property/age" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser3ageGSqCSo8NSNumber_">age</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties3AgeFMS0_S0_">UsergridUserProperties.Age</a></code>.</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">age</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridUser15usernameOrEmailGSqSS_"></a>
- <a name="//apple_ref/swift/Property/usernameOrEmail" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser15usernameOrEmailGSqSS_">usernameOrEmail</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method to get the username or email of the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</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">usernameOrEmail</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">username</span> <span class="p">??</span> <span class="k">self</span><span class="o">.</span><span class="n">email</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridUser9activatedSb"></a>
- <a name="//apple_ref/swift/Property/activated" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser9activatedSb">activated</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties9ActivatedFMS0_S0_">UsergridUserProperties.Activated</a></code>.</p>
-
-<p>Indicates whether the user account has been activated or not.</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">activated</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridUser8disabledSb"></a>
- <a name="//apple_ref/swift/Property/disabled" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser8disabledSb">disabled</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties8DisabledFMS0_S0_">UsergridUserProperties.Disabled</a></code>.</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">disabled</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridUser7pictureGSqSS_"></a>
- <a name="//apple_ref/swift/Property/picture" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser7pictureGSqSS_">picture</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties7PictureFMS0_S0_">UsergridUserProperties.Picture</a></code>.</p>
-
-<p>URL path to user\u2019s profile picture. Defaults to Gravatar for email address.</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">picture</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:vC11UsergridSDK12UsergridUser14uuidOrUsernameGSqSS_"></a>
- <a name="//apple_ref/swift/Property/uuidOrUsername" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser14uuidOrUsernameGSqSS_">uuidOrUsername</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The UUID or username property value if found.</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">uuidOrUsername</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">uuid</span> <span class="p">??</span> <span class="k">self</span><span class="o">.</span><span class="n">username</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:FC11UsergridSDK12UsergridUsercFT4nameGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(name:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameGSqSS__S0_">init(name:)</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/UsergridUser.html">UsergridUser</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">name</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>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the user. Note this is different from the <code>username</code> property.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a>
- <a name="//apple_ref/swift/Method/init(type:name:propertyDict:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_">init(type:name:propertyDict:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The required public initializer for <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> subclasses.</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="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">propertyDict</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></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The type associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional name associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>propertyDict</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional property dictionary that the <code>UsergridEntity</code> object will start out with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameSS12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a>
- <a name="//apple_ref/swift/Method/init(name:propertyDict:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameSS12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_">init(name:propertyDict:)</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/UsergridUser.html">UsergridUser</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">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span><span class="nv">propertyDict</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></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the user. Note this is different from the <code>username</code> property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>propertyDict</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional property dictionary that the <code>UsergridEntity</code> object will start out with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameSS5emailSS8passwordGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(name:email:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameSS5emailSS8passwordGSqSS__S0_">init(name:email:password:)</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/UsergridUser.html">UsergridUser</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">email</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the user. Note this is different from the <code>username</code> property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>email</em>
- </code>
- </td>
- <td>
- <div>
- <p>The user’s email.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s password.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT5emailSS8passwordGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(email:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT5emailSS8passwordGSqSS__S0_">init(email:password:)</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/UsergridUser.html">UsergridUser</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">email</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>email</em>
- </code>
- </td>
- <td>
- <div>
- <p>The user’s email.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s password.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameSS8usernameSS8passwordGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(name:username:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameSS8usernameSS8passwordGSqSS__S0_">init(name:username:password:)</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/UsergridUser.html">UsergridUser</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the user. Note this is different from the <code>username</code> property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username of the user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s password.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT8usernameSS8passwordGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(username:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT8usernameSS8passwordGSqSS__S0_">init(username:password:)</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/UsergridUser.html">UsergridUser</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username of the user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s password.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameGSqSS_5emailGSqSS_8usernameGSqSS_8passwordGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(name:email:username:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameGSqSS_5emailGSqSS_8usernameGSqSS_8passwordGSqSS__S0_">init(name:email:username:password:)</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/UsergridUser.html">UsergridUser</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">email</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">password</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>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional name of the user. Note this is different from the <code>username</code> property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>email</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s email.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional username of the user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s password.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</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:FC11UsergridSDK12UsergridUsercFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT5coderCSo7NSCoder_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:FC11UsergridSDK12UsergridUser15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser15encodeWithCoderFCSo7NSCoderT_">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="k">override</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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Class%20Methods"></a>
- <a name="//apple_ref/swift/Section/Class Methods" class="dashAnchor"></a>
- <a href="#/Class%20Methods">
- <h3 class="section-name">Class Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_"></a>
- <a name="//apple_ref/swift/Method/checkAvailable(_:username:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_">checkAvailable(_:username:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Checks the given email and/or username availablity for new <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">checkAvailable</span><span class="p">(</span><span class="nv">email</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserAvailabilityCompletion</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>email</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional email address.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional username.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTCS_14UsergridClient5emailGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_"></a>
- <a name="//apple_ref/swift/Method/checkAvailable(_:email:username:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTCS_14UsergridClient5emailGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_">checkAvailable(_:email:username:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Checks the given email and/or username availablity for new <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects using with the given <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">checkAvailable</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">email</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserAvailabilityCompletion</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use for checking availability.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>email</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional email address.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional username.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Instance%20Methods"></a>
- <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
- <a href="#/Instance%20Methods">
- <h3 class="section-name">Instance Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUser6createFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/create(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser6createFTGSqFT8responseCS_16UsergridResponse_T___T_">create(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates the user object in Usergrid if the user does not already exist with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">create</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUser6createFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/create(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser6createFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">create(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates the user object in Usergrid if the user does not already exist with the given <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">create</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use for creation.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUser5loginFTSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/login(_:password:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser5loginFTSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__T___T_">login(_:password:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates the specified user using the provided username and password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
-<p>While functionally similar to <code>UsergridClient.authenticateUser(auth)</code>, this method does not automatically assign this user to <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>:</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">login</span><span class="p">(</span><span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUser5loginFTCS_14UsergridClient8usernameSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/login(_:username:password:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser5loginFTCS_14UsergridClient8usernameSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__T___T_">login(_:username:password:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates the specified user using the provided username and password.</p>
-
-<p>While functionally similar to <code>UsergridClient.authenticateUser(auth)</code>, this method does not automatically assign this user to <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>:</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">login</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use for login.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUser13resetPasswordFTSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a>
- <a name="//apple_ref/swift/Method/resetPassword(_:new:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser13resetPasswordFTSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:new:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Changes the User’s current password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">resetPassword</span><span class="p">(</span><span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><spa
<TRUNCATED>
[50/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Readme.md
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Readme.md b/sdks/swift/Samples/ActivityFeed/Readme.md
deleted file mode 100644
index 9fb6555..0000000
--- a/sdks/swift/Samples/ActivityFeed/Readme.md
+++ /dev/null
@@ -1,29 +0,0 @@
-#ActivityFeed
-
-## Installing dependencies
-
-The `ActivityFeed` sample app utilizes `Cocoapods` and you will need to run the `$ pod install` command from within the root folder of the sample project in order for the sample to run properly.
-
-## Running the Sample
-
-To run the sample app, simply open the `ActivityFeed.xcworkspace` file in Xcode.
-
-Two targets in Xcode specific to this application will be available:
-
-- **ActivityFeed Target**
-
- This will run the iOS sample application.
-
-- **Watch Sample Target**
-
- This will run the watchOS companion app.
-
-##Configuring the Sample Apps
-
-Before running the sample applications you will need to configure each sample application.
-
-Each sample application should include a source file named `UsergridManager.swift`. This source file is used to contain interaction with the UsergridSDK within a single source file. In doing so, the interactions within the sample apps can be easily seen and examined.
-
-Within the `UsergridManager.swift` source there will be at least two different static vars named `ORG_ID` and `APP_ID`. You will need to configure those values in order to run the applications in your environment.
-
-Applications which utilize push notifications will require a valid provisioning profile and device for the push services to work correctly.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/ActivityEntity.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/ActivityEntity.swift b/sdks/swift/Samples/ActivityFeed/Source/ActivityEntity.swift
deleted file mode 100644
index 5ddcf12..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/ActivityEntity.swift
+++ /dev/null
@@ -1,60 +0,0 @@
-//
-// ActivityEntity.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 1/20/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import UsergridSDK
-
-public class ActivityEntity: UsergridEntity {
-
- public var actor: [String:AnyObject]? { return self["actor"] as? [String:AnyObject] }
-
- public var content: String? { return self["content"] as? String }
-
- public var displayName: String? { return self.actor?["displayName"] as? String }
-
- public var email: String? { return self.actor?["email"] as? String }
-
- public var imageInfo: [String:AnyObject]? { return self.actor?["image"] as? [String:AnyObject] }
-
- public var imageURL: String? { return self.imageInfo?["url"] as? String }
-
- static func registerSubclass() {
- UsergridEntity.mapCustomType("activity", toSubclass: ActivityEntity.self)
- }
-
- required public init(type: String, name: String?, propertyDict: [String : AnyObject]?) {
- super.init(type: type, name: name, propertyDict: propertyDict)
- }
-
- required public init?(coder aDecoder: NSCoder) {
- super.init(coder: aDecoder)
- }
-
- public override func encodeWithCoder(aCoder: NSCoder) {
- super.encodeWithCoder(aCoder)
- }
-
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/AppDelegate.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/AppDelegate.swift b/sdks/swift/Samples/ActivityFeed/Source/AppDelegate.swift
deleted file mode 100644
index cca5c41..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/AppDelegate.swift
+++ /dev/null
@@ -1,65 +0,0 @@
-//
-// AppDelegate.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 11/19/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-
-import UIKit
-import UsergridSDK
-
-// TODO: Change the values to correspond to your organization, application, and notifier identifiers.
-
-@UIApplicationMain class AppDelegate: UIResponder, UIApplicationDelegate {
-
- var window: UIWindow?
-
- func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
-
- UINavigationBar.appearance().tintColor = UIColor.whiteColor()
- application.registerUserNotificationSettings(UIUserNotificationSettings( forTypes: [.Alert, .Badge, .Sound], categories: nil))
- application.registerForRemoteNotifications()
-
- // Initialize the Usergrid shared instance.
- UsergridManager.initializeSharedInstance()
-
- // If there is a current user already logged in from the keychain we will skip the login page and go right to the chat screen
-
- if Usergrid.currentUser != nil {
- let rootViewController = self.window!.rootViewController as! UINavigationController
- let loginViewController = rootViewController.viewControllers.first!
- loginViewController.performSegueWithIdentifier("loginSuccessNonAnimatedSegue", sender: loginViewController)
- }
-
- return true
- }
-
- func application(application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: NSData) {
- Usergrid.applyPushToken(deviceToken, notifierID: UsergridManager.NOTIFIER_ID, completion: nil)
- }
-
- func application(application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: NSError) {
- print("Application failed to register for remote notifications")
- }
-}
-
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/AppIcon.appiconset/Contents.json
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/AppIcon.appiconset/Contents.json b/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/AppIcon.appiconset/Contents.json
deleted file mode 100644
index 118c98f..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/AppIcon.appiconset/Contents.json
+++ /dev/null
@@ -1,38 +0,0 @@
-{
- "images" : [
- {
- "idiom" : "iphone",
- "size" : "29x29",
- "scale" : "2x"
- },
- {
- "idiom" : "iphone",
- "size" : "29x29",
- "scale" : "3x"
- },
- {
- "idiom" : "iphone",
- "size" : "40x40",
- "scale" : "2x"
- },
- {
- "idiom" : "iphone",
- "size" : "40x40",
- "scale" : "3x"
- },
- {
- "idiom" : "iphone",
- "size" : "60x60",
- "scale" : "2x"
- },
- {
- "idiom" : "iphone",
- "size" : "60x60",
- "scale" : "3x"
- }
- ],
- "info" : {
- "version" : 1,
- "author" : "xcode"
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/Contents.json
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/Contents.json b/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/Contents.json
deleted file mode 100644
index da4a164..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/Contents.json
+++ /dev/null
@@ -1,6 +0,0 @@
-{
- "info" : {
- "version" : 1,
- "author" : "xcode"
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/UsergridGuy.imageset/Contents.json
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/UsergridGuy.imageset/Contents.json b/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/UsergridGuy.imageset/Contents.json
deleted file mode 100644
index c19ad83..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/UsergridGuy.imageset/Contents.json
+++ /dev/null
@@ -1,21 +0,0 @@
-{
- "images" : [
- {
- "idiom" : "universal",
- "filename" : "UsergridGuy.png",
- "scale" : "1x"
- },
- {
- "idiom" : "universal",
- "scale" : "2x"
- },
- {
- "idiom" : "universal",
- "scale" : "3x"
- }
- ],
- "info" : {
- "version" : 1,
- "author" : "xcode"
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/UsergridGuy.imageset/UsergridGuy.png
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/UsergridGuy.imageset/UsergridGuy.png b/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/UsergridGuy.imageset/UsergridGuy.png
deleted file mode 100644
index b8a6844..0000000
Binary files a/sdks/swift/Samples/ActivityFeed/Source/Assets.xcassets/UsergridGuy.imageset/UsergridGuy.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/Base.lproj/LaunchScreen.storyboard
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/Base.lproj/LaunchScreen.storyboard b/sdks/swift/Samples/ActivityFeed/Source/Base.lproj/LaunchScreen.storyboard
deleted file mode 100644
index 78686cd..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/Base.lproj/LaunchScreen.storyboard
+++ /dev/null
@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="9531" systemVersion="15C50" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" launchScreen="YES" useTraitCollections="YES" initialViewController="01J-lp-oVM">
- <dependencies>
- <deployment identifier="iOS"/>
- <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="9529"/>
- </dependencies>
- <scenes>
- <!--View Controller-->
- <scene sceneID="EHf-IW-A2E">
- <objects>
- <viewController id="01J-lp-oVM" sceneMemberID="viewController">
- <layoutGuides>
- <viewControllerLayoutGuide type="top" id="Llm-lL-Icb"/>
- <viewControllerLayoutGuide type="bottom" id="xb3-aO-Qok"/>
- </layoutGuides>
- <view key="view" contentMode="scaleToFill" id="Ze5-6b-2t3">
- <rect key="frame" x="0.0" y="0.0" width="600" height="600"/>
- <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
- <color key="backgroundColor" white="1" alpha="1" colorSpace="custom" customColorSpace="calibratedWhite"/>
- </view>
- </viewController>
- <placeholder placeholderIdentifier="IBFirstResponder" id="iYj-Kq-Ea1" userLabel="First Responder" sceneMemberID="firstResponder"/>
- </objects>
- <point key="canvasLocation" x="53" y="375"/>
- </scene>
- </scenes>
-</document>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/Base.lproj/Main.storyboard
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/Base.lproj/Main.storyboard b/sdks/swift/Samples/ActivityFeed/Source/Base.lproj/Main.storyboard
deleted file mode 100644
index 8ec5316..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/Base.lproj/Main.storyboard
+++ /dev/null
@@ -1,371 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="10117" systemVersion="15E65" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" initialViewController="0Ca-En-eac">
- <dependencies>
- <deployment identifier="iOS"/>
- <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="10085"/>
- <capability name="Constraints to layout margins" minToolsVersion="6.0"/>
- </dependencies>
- <scenes>
- <!--Navigation Controller-->
- <scene sceneID="b6o-SG-nHZ">
- <objects>
- <navigationController id="0Ca-En-eac" sceneMemberID="viewController">
- <simulatedScreenMetrics key="simulatedDestinationMetrics" type="retina55"/>
- <navigationBar key="navigationBar" contentMode="scaleToFill" translucent="NO" id="kgZ-6Y-2Hs">
- <rect key="frame" x="0.0" y="0.0" width="320" height="44"/>
- <autoresizingMask key="autoresizingMask"/>
- <color key="barTintColor" red="0.10196078431372549" green="0.41176470588235292" blue="0.56862745098039214" alpha="1" colorSpace="calibratedRGB"/>
- <textAttributes key="titleTextAttributes">
- <color key="textColor" red="0.97647058823529409" green="0.97647058823529409" blue="0.97647058823529409" alpha="1" colorSpace="calibratedRGB"/>
- </textAttributes>
- </navigationBar>
- <connections>
- <segue destination="BYZ-38-t0r" kind="relationship" relationship="rootViewController" id="JkM-3e-aQt"/>
- </connections>
- </navigationController>
- <placeholder placeholderIdentifier="IBFirstResponder" id="KGr-0J-SBp" userLabel="First Responder" sceneMemberID="firstResponder"/>
- </objects>
- <point key="canvasLocation" x="-191" y="350"/>
- </scene>
- <!--Chit-Chat-->
- <scene sceneID="tne-QT-ifu">
- <objects>
- <viewController title="Chit-Chat" id="BYZ-38-t0r" customClass="LoginViewController" customModule="ActivityFeed" customModuleProvider="target" sceneMemberID="viewController">
- <layoutGuides>
- <viewControllerLayoutGuide type="top" id="y3c-jy-aDJ"/>
- <viewControllerLayoutGuide type="bottom" id="wfy-db-euE"/>
- </layoutGuides>
- <view key="view" contentMode="scaleToFill" id="8bC-Xf-vdC">
- <rect key="frame" x="0.0" y="64" width="414" height="672"/>
- <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
- <subviews>
- <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="Password" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="AUv-4K-02z" userLabel="Password Text Field" customClass="FormTextField" customModule="ActivityFeed" customModuleProvider="target">
- <rect key="frame" x="55" y="221" width="305" height="30"/>
- <color key="backgroundColor" red="0.98039215686274506" green="0.98039215686274506" blue="0.98039215686274506" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstAttribute="height" constant="30" id="ttP-ff-vrA"/>
- </constraints>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="14"/>
- <textInputTraits key="textInputTraits" returnKeyType="done" secureTextEntry="YES"/>
- <userDefinedRuntimeAttributes>
- <userDefinedRuntimeAttribute type="number" keyPath="inset">
- <real key="value" value="10"/>
- </userDefinedRuntimeAttribute>
- </userDefinedRuntimeAttributes>
- <connections>
- <outlet property="nextResponderField" destination="Pj4-c5-WOw" id="ndL-qj-xzY"/>
- </connections>
- </textField>
- <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="Username" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="Z6O-sS-NMx" customClass="FormTextField" customModule="ActivityFeed" customModuleProvider="target">
- <rect key="frame" x="54" y="183" width="305" height="30"/>
- <color key="backgroundColor" red="0.98431372549019602" green="0.98431372549019602" blue="0.98431372549019602" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstAttribute="height" constant="30" id="Dcr-HX-coh"/>
- </constraints>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="14"/>
- <textInputTraits key="textInputTraits" returnKeyType="next"/>
- <userDefinedRuntimeAttributes>
- <userDefinedRuntimeAttribute type="number" keyPath="inset">
- <real key="value" value="10"/>
- </userDefinedRuntimeAttribute>
- </userDefinedRuntimeAttributes>
- <connections>
- <outlet property="nextResponderField" destination="AUv-4K-02z" id="NLo-pL-jk4"/>
- </connections>
- </textField>
- <button opaque="NO" clearsContextBeforeDrawing="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="Pj4-c5-WOw" userLabel="Sign In ">
- <rect key="frame" x="54" y="287" width="305" height="45"/>
- <color key="backgroundColor" red="0.10196078431372549" green="0.41568627450980394" blue="0.58039215686274515" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstAttribute="height" constant="45" id="iPw-MQ-dMe"/>
- </constraints>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="15"/>
- <state key="normal" title="Sign In">
- <color key="titleColor" red="1" green="1" blue="1" alpha="1" colorSpace="calibratedRGB"/>
- </state>
- <connections>
- <action selector="loginButtonTouched:" destination="BYZ-38-t0r" eventType="touchUpInside" id="I2Z-mw-as5"/>
- </connections>
- </button>
- <button opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="JLH-ZA-uPM">
- <rect key="frame" x="128" y="360" width="157" height="30"/>
- <constraints>
- <constraint firstAttribute="width" constant="157" id="Wo1-xd-zeb"/>
- </constraints>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="15"/>
- <state key="normal" title="Create Account">
- <color key="titleColor" red="0.090196078431372548" green="0.33725490196078434" blue="0.50588235294117645" alpha="1" colorSpace="calibratedRGB"/>
- </state>
- <connections>
- <segue destination="bnr-oZ-e0h" kind="show" identifier="signUpSegue" id="NXY-Nd-h56"/>
- </connections>
- </button>
- <imageView userInteractionEnabled="NO" contentMode="scaleAspectFit" horizontalHuggingPriority="251" verticalHuggingPriority="251" image="UsergridGuy" translatesAutoresizingMaskIntoConstraints="NO" id="t6Y-SG-C6M">
- <rect key="frame" x="128" y="41" width="169" height="105"/>
- </imageView>
- </subviews>
- <color key="backgroundColor" red="0.92941176470588238" green="0.94509803921568625" blue="0.94509803921568625" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstItem="Pj4-c5-WOw" firstAttribute="top" secondItem="AUv-4K-02z" secondAttribute="bottom" constant="36" id="0Go-pE-u4p"/>
- <constraint firstItem="AUv-4K-02z" firstAttribute="leading" secondItem="8bC-Xf-vdC" secondAttribute="leadingMargin" constant="35" id="2Xa-2C-BzP"/>
- <constraint firstAttribute="trailingMargin" secondItem="t6Y-SG-C6M" secondAttribute="trailing" constant="97" id="BQF-rx-fX4"/>
- <constraint firstItem="Z6O-sS-NMx" firstAttribute="trailing" secondItem="Pj4-c5-WOw" secondAttribute="trailing" id="CLi-7t-9Bm"/>
- <constraint firstItem="Z6O-sS-NMx" firstAttribute="leading" secondItem="8bC-Xf-vdC" secondAttribute="leadingMargin" constant="34" id="H8h-Dc-gGd"/>
- <constraint firstItem="AUv-4K-02z" firstAttribute="centerX" secondItem="8bC-Xf-vdC" secondAttribute="centerX" id="ML2-oF-zNc"/>
- <constraint firstItem="AUv-4K-02z" firstAttribute="top" secondItem="Z6O-sS-NMx" secondAttribute="bottom" constant="8" symbolic="YES" id="T1u-Ae-7qT"/>
- <constraint firstItem="t6Y-SG-C6M" firstAttribute="leading" secondItem="JLH-ZA-uPM" secondAttribute="leading" id="UkI-we-10P"/>
- <constraint firstItem="Pj4-c5-WOw" firstAttribute="top" secondItem="8bC-Xf-vdC" secondAttribute="top" constant="287" id="WHX-b2-vXU"/>
- <constraint firstItem="JLH-ZA-uPM" firstAttribute="centerX" secondItem="8bC-Xf-vdC" secondAttribute="centerX" id="adR-S0-Zw5"/>
- <constraint firstItem="Z6O-sS-NMx" firstAttribute="top" secondItem="t6Y-SG-C6M" secondAttribute="bottom" constant="37" id="cDN-ea-Z7L"/>
- <constraint firstItem="t6Y-SG-C6M" firstAttribute="top" secondItem="y3c-jy-aDJ" secondAttribute="bottom" constant="41" id="ciX-r9-UzJ"/>
- <constraint firstItem="JLH-ZA-uPM" firstAttribute="top" secondItem="Pj4-c5-WOw" secondAttribute="bottom" constant="28" id="h7B-Kf-fPS"/>
- <constraint firstItem="Z6O-sS-NMx" firstAttribute="top" secondItem="y3c-jy-aDJ" secondAttribute="bottom" constant="183" id="lIk-q4-Kkm"/>
- <constraint firstItem="Z6O-sS-NMx" firstAttribute="leading" secondItem="Pj4-c5-WOw" secondAttribute="leading" id="wi1-xU-x6C"/>
- <constraint firstItem="JLH-ZA-uPM" firstAttribute="centerX" secondItem="Pj4-c5-WOw" secondAttribute="centerX" id="xPz-Hj-Iv4"/>
- </constraints>
- </view>
- <navigationItem key="navigationItem" id="9X6-oC-0Ku">
- <barButtonItem key="backBarButtonItem" title=" " id="saf-1i-WZ7"/>
- </navigationItem>
- <simulatedScreenMetrics key="simulatedDestinationMetrics" type="retina55"/>
- <connections>
- <outlet property="passwordTextField" destination="AUv-4K-02z" id="ck2-dw-K3H"/>
- <outlet property="usernameTextField" destination="Z6O-sS-NMx" id="jz7-0z-YRA"/>
- <segue destination="e2L-gy-keG" kind="show" identifier="loginSuccessSegue" id="yFG-ee-xdi"/>
- <segue destination="e2L-gy-keG" kind="show" identifier="loginSuccessNonAnimatedSegue" animates="NO" id="jbi-vT-etg"/>
- </connections>
- </viewController>
- <placeholder placeholderIdentifier="IBFirstResponder" id="dkx-z0-nzr" sceneMemberID="firstResponder"/>
- </objects>
- <point key="canvasLocation" x="414" y="362"/>
- </scene>
- <!--Chat-->
- <scene sceneID="xKw-pF-1VK">
- <objects>
- <viewController storyboardIdentifier="Chat" id="e2L-gy-keG" customClass="MessageViewController" customModule="ActivityFeed" customModuleProvider="target" sceneMemberID="viewController">
- <layoutGuides>
- <viewControllerLayoutGuide type="top" id="l0J-tj-N8R"/>
- <viewControllerLayoutGuide type="bottom" id="aRQ-i9-bBv"/>
- </layoutGuides>
- <view key="view" contentMode="scaleToFill" id="gFB-Jy-DrN">
- <rect key="frame" x="0.0" y="64" width="414" height="672"/>
- <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
- <color key="backgroundColor" red="0.90980392156862744" green="0.93333333333333335" blue="0.92941176470588238" alpha="1" colorSpace="calibratedRGB"/>
- </view>
- <extendedEdge key="edgesForExtendedLayout" bottom="YES"/>
- <navigationItem key="navigationItem" title="Chat" id="A1Z-Fm-fb7" userLabel="Chat">
- <barButtonItem key="backBarButtonItem" title=" " id="lTa-eA-MlI"/>
- <barButtonItem key="rightBarButtonItem" title="Follow" id="oWz-oN-r0q">
- <connections>
- <segue destination="dZf-Pa-FEf" kind="show" id="4hi-xR-y7a"/>
- </connections>
- </barButtonItem>
- </navigationItem>
- <simulatedScreenMetrics key="simulatedDestinationMetrics" type="retina55"/>
- </viewController>
- <placeholder placeholderIdentifier="IBFirstResponder" id="KDg-MX-rlV" userLabel="First Responder" sceneMemberID="firstResponder"/>
- <exit id="Vtr-ga-m5m" userLabel="Exit" sceneMemberID="exit"/>
- </objects>
- <point key="canvasLocation" x="873" y="692"/>
- </scene>
- <!--Follow-->
- <scene sceneID="L1J-vW-kjp">
- <objects>
- <viewController id="dZf-Pa-FEf" customClass="FollowViewController" customModule="ActivityFeed" customModuleProvider="target" sceneMemberID="viewController">
- <layoutGuides>
- <viewControllerLayoutGuide type="top" id="bqC-DA-7jl"/>
- <viewControllerLayoutGuide type="bottom" id="WfX-kG-aQR"/>
- </layoutGuides>
- <view key="view" contentMode="scaleToFill" id="qAg-Dl-t9F">
- <rect key="frame" x="0.0" y="64" width="414" height="672"/>
- <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
- <subviews>
- <button opaque="NO" clearsContextBeforeDrawing="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="dSM-Kh-jtM" userLabel="Sign In ">
- <rect key="frame" x="55" y="304" width="305" height="45"/>
- <color key="backgroundColor" red="0.090196078431372548" green="0.33333333333333331" blue="0.49411764705882355" alpha="1" colorSpace="calibratedRGB"/>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="15"/>
- <state key="normal" title="Add Follower">
- <color key="titleColor" red="1" green="1" blue="1" alpha="1" colorSpace="calibratedRGB"/>
- </state>
- <connections>
- <action selector="addFollowerButtonTouched:" destination="dZf-Pa-FEf" eventType="touchUpInside" id="yuv-da-ArK"/>
- </connections>
- </button>
- <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="Username" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="30w-Hq-z3n" customClass="FormTextField" customModule="ActivityFeed" customModuleProvider="target">
- <rect key="frame" x="55" y="229" width="305" height="30"/>
- <color key="backgroundColor" red="0.98431372549999996" green="0.98431372549999996" blue="0.98431372549999996" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstAttribute="height" constant="30" id="VgQ-oU-xSh"/>
- </constraints>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="14"/>
- <textInputTraits key="textInputTraits" returnKeyType="next"/>
- <userDefinedRuntimeAttributes>
- <userDefinedRuntimeAttribute type="number" keyPath="inset">
- <real key="value" value="10"/>
- </userDefinedRuntimeAttribute>
- </userDefinedRuntimeAttributes>
- <connections>
- <outlet property="nextResponderField" destination="dSM-Kh-jtM" id="JKY-WD-0wK"/>
- </connections>
- </textField>
- </subviews>
- <color key="backgroundColor" red="0.90980392156862744" green="0.93333333333333335" blue="0.92941176470588238" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstItem="30w-Hq-z3n" firstAttribute="leading" secondItem="qAg-Dl-t9F" secondAttribute="leadingMargin" constant="35" id="ETC-Hj-qu0"/>
- <constraint firstItem="dSM-Kh-jtM" firstAttribute="leading" secondItem="30w-Hq-z3n" secondAttribute="leading" id="MrI-EB-S4Q"/>
- <constraint firstItem="dSM-Kh-jtM" firstAttribute="centerX" secondItem="qAg-Dl-t9F" secondAttribute="centerX" id="XGA-b6-Kbm"/>
- <constraint firstItem="dSM-Kh-jtM" firstAttribute="top" secondItem="30w-Hq-z3n" secondAttribute="bottom" constant="45" id="hYz-y9-k2e"/>
- <constraint firstItem="30w-Hq-z3n" firstAttribute="trailing" secondItem="dSM-Kh-jtM" secondAttribute="trailing" id="jBo-UK-A49"/>
- <constraint firstItem="WfX-kG-aQR" firstAttribute="top" secondItem="dSM-Kh-jtM" secondAttribute="bottom" constant="323" id="l8c-Ap-E9b"/>
- <constraint firstItem="30w-Hq-z3n" firstAttribute="top" secondItem="bqC-DA-7jl" secondAttribute="bottom" constant="229" id="p7k-Gp-8pf"/>
- </constraints>
- </view>
- <navigationItem key="navigationItem" title="Follow" id="j5X-9C-znz">
- <barButtonItem key="backBarButtonItem" id="HXY-KA-xWY"/>
- </navigationItem>
- <simulatedScreenMetrics key="simulatedDestinationMetrics" type="retina55"/>
- <connections>
- <outlet property="usernameTextField" destination="30w-Hq-z3n" id="QcA-z0-XWe"/>
- <segue destination="Vtr-ga-m5m" kind="unwind" identifier="unwindToChatSegue" unwindAction="unwindToChat:" id="uwe-tT-3Yl"/>
- </connections>
- </viewController>
- <placeholder placeholderIdentifier="IBFirstResponder" id="P87-dE-iQW" userLabel="First Responder" sceneMemberID="firstResponder"/>
- </objects>
- <point key="canvasLocation" x="1334" y="692"/>
- </scene>
- <!--Create Account-->
- <scene sceneID="KTq-tk-yrN">
- <objects>
- <viewController title="Create Account" id="bnr-oZ-e0h" customClass="RegisterViewController" customModule="ActivityFeed" customModuleProvider="target" sceneMemberID="viewController">
- <layoutGuides>
- <viewControllerLayoutGuide type="top" id="54e-JK-PBR"/>
- <viewControllerLayoutGuide type="bottom" id="JWP-YK-0Zj"/>
- </layoutGuides>
- <view key="view" contentMode="scaleToFill" id="8bt-vM-LeI">
- <rect key="frame" x="0.0" y="64" width="414" height="672"/>
- <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
- <subviews>
- <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="Name" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="X55-Ni-6OO" customClass="FormTextField" customModule="ActivityFeed" customModuleProvider="target">
- <rect key="frame" x="55" y="112" width="305" height="30"/>
- <color key="backgroundColor" red="0.98431372549999996" green="0.98431372549999996" blue="0.98431372549999996" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstAttribute="height" constant="30" id="e0c-yJ-CZz"/>
- </constraints>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="14"/>
- <textInputTraits key="textInputTraits" returnKeyType="next"/>
- <userDefinedRuntimeAttributes>
- <userDefinedRuntimeAttribute type="number" keyPath="inset">
- <real key="value" value="10"/>
- </userDefinedRuntimeAttribute>
- </userDefinedRuntimeAttributes>
- <connections>
- <outlet property="nextResponderField" destination="T7U-9G-AS6" id="HUF-el-scZ"/>
- </connections>
- </textField>
- <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="Username" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="T7U-9G-AS6" userLabel="Username Text Field" customClass="FormTextField" customModule="ActivityFeed" customModuleProvider="target">
- <rect key="frame" x="55" y="150" width="305" height="30"/>
- <color key="backgroundColor" red="0.98431372549999996" green="0.98431372549999996" blue="0.98431372549999996" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstAttribute="height" constant="30" id="AdR-w9-g8s"/>
- </constraints>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="14"/>
- <textInputTraits key="textInputTraits" returnKeyType="next"/>
- <userDefinedRuntimeAttributes>
- <userDefinedRuntimeAttribute type="number" keyPath="inset">
- <real key="value" value="10"/>
- </userDefinedRuntimeAttribute>
- </userDefinedRuntimeAttributes>
- <connections>
- <outlet property="nextResponderField" destination="Fbi-gF-0jQ" id="sjv-Dm-5GL"/>
- </connections>
- </textField>
- <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="Email" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="Fbi-gF-0jQ" customClass="FormTextField" customModule="ActivityFeed" customModuleProvider="target">
- <rect key="frame" x="55" y="188" width="305" height="30"/>
- <color key="backgroundColor" red="0.98431372549999996" green="0.98431372549999996" blue="0.98431372549999996" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstAttribute="height" constant="30" id="BEM-zO-uYG"/>
- </constraints>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="14"/>
- <textInputTraits key="textInputTraits" keyboardType="emailAddress" returnKeyType="next"/>
- <userDefinedRuntimeAttributes>
- <userDefinedRuntimeAttribute type="number" keyPath="inset">
- <real key="value" value="10"/>
- </userDefinedRuntimeAttribute>
- </userDefinedRuntimeAttributes>
- <connections>
- <outlet property="nextResponderField" destination="3wi-7s-j5P" id="eE7-9Y-L0t"/>
- </connections>
- </textField>
- <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="Password" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="3wi-7s-j5P" userLabel="Password Text Field" customClass="FormTextField" customModule="ActivityFeed" customModuleProvider="target">
- <rect key="frame" x="55" y="226" width="305" height="30"/>
- <color key="backgroundColor" red="0.98431372549999996" green="0.98431372549999996" blue="0.98431372549999996" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstAttribute="height" constant="30" id="N5y-wK-RFi"/>
- </constraints>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="14"/>
- <textInputTraits key="textInputTraits" returnKeyType="done" secureTextEntry="YES"/>
- <userDefinedRuntimeAttributes>
- <userDefinedRuntimeAttribute type="number" keyPath="inset">
- <real key="value" value="10"/>
- </userDefinedRuntimeAttribute>
- </userDefinedRuntimeAttributes>
- <connections>
- <outlet property="nextResponderField" destination="1LM-SB-xON" id="igH-69-KP4"/>
- </connections>
- </textField>
- <button opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="1LM-SB-xON" userLabel="Create Account Button">
- <rect key="frame" x="129" y="311" width="157" height="30"/>
- <constraints>
- <constraint firstAttribute="width" constant="157" id="FnB-G6-Riq"/>
- <constraint firstAttribute="height" constant="30" id="q9P-Oj-aoj"/>
- </constraints>
- <fontDescription key="fontDescription" type="system" weight="medium" pointSize="15"/>
- <state key="normal" title="Create Account">
- <color key="titleColor" red="0.090196078431372548" green="0.33333333333333331" blue="0.49019607843137253" alpha="1" colorSpace="calibratedRGB"/>
- </state>
- <connections>
- <action selector="registerButtonTouched:" destination="bnr-oZ-e0h" eventType="touchUpInside" id="GSH-40-K9q"/>
- </connections>
- </button>
- </subviews>
- <color key="backgroundColor" red="0.90980392156862744" green="0.93333333333333335" blue="0.92941176470588238" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstItem="Fbi-gF-0jQ" firstAttribute="top" secondItem="T7U-9G-AS6" secondAttribute="bottom" constant="8" symbolic="YES" id="47R-E5-Snv"/>
- <constraint firstItem="X55-Ni-6OO" firstAttribute="leading" secondItem="8bt-vM-LeI" secondAttribute="leadingMargin" constant="35" id="4AX-MS-GG7"/>
- <constraint firstItem="3wi-7s-j5P" firstAttribute="centerX" secondItem="1LM-SB-xON" secondAttribute="centerX" id="6sW-Fh-Rab"/>
- <constraint firstItem="X55-Ni-6OO" firstAttribute="top" secondItem="54e-JK-PBR" secondAttribute="bottom" constant="112" id="8Po-i9-42g"/>
- <constraint firstItem="Fbi-gF-0jQ" firstAttribute="leading" secondItem="3wi-7s-j5P" secondAttribute="leading" id="Aun-rI-OR3"/>
- <constraint firstItem="T7U-9G-AS6" firstAttribute="leading" secondItem="X55-Ni-6OO" secondAttribute="leading" id="BdL-Nz-LD6"/>
- <constraint firstItem="Fbi-gF-0jQ" firstAttribute="trailing" secondItem="3wi-7s-j5P" secondAttribute="trailing" id="KdZ-Tm-Bwx"/>
- <constraint firstItem="T7U-9G-AS6" firstAttribute="trailing" secondItem="X55-Ni-6OO" secondAttribute="trailing" id="RYI-tz-VCv"/>
- <constraint firstItem="Fbi-gF-0jQ" firstAttribute="trailing" secondItem="T7U-9G-AS6" secondAttribute="trailing" id="fw6-6b-cmI"/>
- <constraint firstItem="3wi-7s-j5P" firstAttribute="top" secondItem="Fbi-gF-0jQ" secondAttribute="bottom" constant="8" symbolic="YES" id="geo-x8-ZFP"/>
- <constraint firstItem="Fbi-gF-0jQ" firstAttribute="leading" secondItem="T7U-9G-AS6" secondAttribute="leading" id="jQL-Ia-0fq"/>
- <constraint firstItem="1LM-SB-xON" firstAttribute="top" secondItem="3wi-7s-j5P" secondAttribute="bottom" constant="55" id="p5i-2x-Yya"/>
- <constraint firstItem="X55-Ni-6OO" firstAttribute="centerX" secondItem="8bt-vM-LeI" secondAttribute="centerX" id="qHj-O7-Oze"/>
- <constraint firstItem="T7U-9G-AS6" firstAttribute="top" secondItem="X55-Ni-6OO" secondAttribute="bottom" constant="8" symbolic="YES" id="wCb-xG-olD"/>
- </constraints>
- </view>
- <navigationItem key="navigationItem" title="Create Account" id="fQg-sg-1cB"/>
- <simulatedScreenMetrics key="simulatedDestinationMetrics" type="retina55"/>
- <connections>
- <outlet property="emailTextField" destination="Fbi-gF-0jQ" id="6Uc-Fs-euO"/>
- <outlet property="nameTextField" destination="X55-Ni-6OO" id="6dQ-5q-zzP"/>
- <outlet property="passwordTextField" destination="3wi-7s-j5P" id="978-dQ-Xd1"/>
- <outlet property="usernameTextField" destination="T7U-9G-AS6" id="K2o-PS-UxH"/>
- <segue destination="Zoo-Jg-Iad" kind="unwind" identifier="unwindSegue" unwindAction="unwind:" id="gdP-wh-1Zx"/>
- </connections>
- </viewController>
- <placeholder placeholderIdentifier="IBFirstResponder" id="VBd-vg-SN9" userLabel="First Responder" sceneMemberID="firstResponder"/>
- <exit id="Zoo-Jg-Iad" userLabel="Exit" sceneMemberID="exit"/>
- </objects>
- <point key="canvasLocation" x="873" y="-128"/>
- </scene>
- </scenes>
- <resources>
- <image name="UsergridGuy" width="162" height="161"/>
- </resources>
- <inferredMetricsTieBreakers>
- <segue reference="yFG-ee-xdi"/>
- </inferredMetricsTieBreakers>
-</document>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/FollowViewController.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/FollowViewController.swift b/sdks/swift/Samples/ActivityFeed/Source/FollowViewController.swift
deleted file mode 100644
index 6362cdb..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/FollowViewController.swift
+++ /dev/null
@@ -1,50 +0,0 @@
-//
-// FollowViewController.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 1/21/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import UIKit
-import UsergridSDK
-
-class FollowViewController : UIViewController {
-
- @IBOutlet weak var usernameTextField: UITextField!
-
- @IBAction func addFollowerButtonTouched(sender:AnyObject?) {
- guard let username = usernameTextField.text where !username.isEmpty
- else {
- self.showAlert(title: "Follow failed.", message: "Please enter a valid username.")
- return
- }
-
- UsergridManager.followUser(username) { (response) -> Void in
- if response.ok {
- self.performSegueWithIdentifier("unwindToChatSegue", sender: self)
- } else {
- self.showAlert(title: "Follow failed.", message: "No user with the username \"\(username)\" found.")
- }
- }
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/FormTextField.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/FormTextField.swift b/sdks/swift/Samples/ActivityFeed/Source/FormTextField.swift
deleted file mode 100644
index fbb9bd6..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/FormTextField.swift
+++ /dev/null
@@ -1,71 +0,0 @@
-//
-// FormTextField.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 1/21/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import UIKit
-
-@IBDesignable class FormTextField: UITextField {
-
- @IBInspectable var inset: CGFloat = 0
- @IBOutlet weak var nextResponderField: UIResponder?
-
- required init?(coder aDecoder: NSCoder) {
- super.init(coder: aDecoder)
- setUp()
- }
-
- override init(frame: CGRect) {
- super.init(frame: frame)
- setUp()
- }
-
- func setUp() {
- addTarget(self, action: #selector(FormTextField.actionKeyboardButtonTapped(_:)), forControlEvents: .EditingDidEndOnExit)
- }
-
- func actionKeyboardButtonTapped(sender: UITextField) {
- switch nextResponderField {
- case let button as UIButton:
- if button.enabled {
- button.sendActionsForControlEvents(.TouchUpInside)
- } else {
- resignFirstResponder()
- }
- case .Some(let responder):
- responder.becomeFirstResponder()
- default:
- resignFirstResponder()
- }
- }
-
- override func textRectForBounds(bounds: CGRect) -> CGRect {
- return CGRectInset(bounds, inset, 0)
- }
-
- override func editingRectForBounds(bounds: CGRect) -> CGRect {
- return textRectForBounds(bounds)
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/Info.plist
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/Info.plist b/sdks/swift/Samples/ActivityFeed/Source/Info.plist
deleted file mode 100644
index 2ea3512..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/Info.plist
+++ /dev/null
@@ -1,43 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
- <key>CFBundleDevelopmentRegion</key>
- <string>en</string>
- <key>CFBundleExecutable</key>
- <string>$(EXECUTABLE_NAME)</string>
- <key>CFBundleIdentifier</key>
- <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
- <key>CFBundleInfoDictionaryVersion</key>
- <string>6.0</string>
- <key>CFBundleName</key>
- <string>$(PRODUCT_NAME)</string>
- <key>CFBundlePackageType</key>
- <string>APPL</string>
- <key>CFBundleShortVersionString</key>
- <string>1.0</string>
- <key>CFBundleSignature</key>
- <string>????</string>
- <key>CFBundleVersion</key>
- <string>1</string>
- <key>LSRequiresIPhoneOS</key>
- <true/>
- <key>NSAppTransportSecurity</key>
- <dict>
- <key>NSAllowsArbitraryLoads</key>
- <true/>
- </dict>
- <key>UILaunchStoryboardName</key>
- <string>LaunchScreen</string>
- <key>UIMainStoryboardFile</key>
- <string>Main</string>
- <key>UIRequiredDeviceCapabilities</key>
- <array>
- <string>armv7</string>
- </array>
- <key>UISupportedInterfaceOrientations</key>
- <array>
- <string>UIInterfaceOrientationPortrait</string>
- </array>
-</dict>
-</plist>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/LoginViewController.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/LoginViewController.swift b/sdks/swift/Samples/ActivityFeed/Source/LoginViewController.swift
deleted file mode 100644
index 0e6c0fa..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/LoginViewController.swift
+++ /dev/null
@@ -1,77 +0,0 @@
-//
-// LoginViewController.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 1/21/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import UIKit
-import UsergridSDK
-
-class LoginViewController: UIViewController {
-
- @IBOutlet weak var usernameTextField: UITextField!
- @IBOutlet weak var passwordTextField: UITextField!
-
- override func viewWillAppear(animated: Bool) {
- super.viewWillAppear(animated)
- self.passwordTextField.text = nil
- }
-
- override func viewDidAppear(animated: Bool) {
- Usergrid.logoutCurrentUser()
- super.viewDidAppear(animated)
- }
-
- override func viewWillDisappear(animated: Bool) {
- super.viewWillDisappear(animated)
- self.view.endEditing(true)
- }
-
- @IBAction func loginButtonTouched(sender: AnyObject) {
- guard let username = usernameTextField.text where !username.isEmpty,
- let password = passwordTextField.text where !password.isEmpty
- else {
- self.showAlert(title: "Error Authenticating User", message: "Username and password must not be empty.")
- return;
- }
-
- self.loginUser(username, password: password)
- }
-
- func loginUser(username:String, password:String) {
- UsergridManager.loginUser(username,password: password) { (auth, user, error) -> Void in
- if let authErrorDescription = error {
- self.showAlert(title: "Error Authenticating User", message: authErrorDescription.errorDescription)
- } else if let authenticatedUser = user {
- self.showAlert(title: "Authenticated User Successful", message: "User description: \n \(authenticatedUser.stringValue)") { (action) -> Void in
- self.performSegueWithIdentifier("loginSuccessSegue", sender: self)
- }
- }
- }
- }
-
- @IBAction func unwind(segue: UIStoryboardSegue) {
- // Used for unwind segues back to this view controller.
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/MessageTableViewCell.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/MessageTableViewCell.swift b/sdks/swift/Samples/ActivityFeed/Source/MessageTableViewCell.swift
deleted file mode 100644
index a77abd8..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/MessageTableViewCell.swift
+++ /dev/null
@@ -1,101 +0,0 @@
-//
-// MessageTableViewCell.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 11/24/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import UIKit
-
-public class MessageTableViewCell : UITableViewCell {
-
- var titleLabel : UILabel
- var bodyLabel : UILabel
- var thumbnailView : UIImageView
- var indexPath : NSIndexPath?
-
- public static let kMessageTableViewCellMinimumHeight: CGFloat = 50.0;
- public static let kMessageTableViewCellAvatarHeight: CGFloat = 30.0;
-
- static var defaultFontSize: CGFloat {
- return 16.0
- }
-
- override init(style: UITableViewCellStyle, reuseIdentifier: String?) {
- self.titleLabel = UILabel(frame: CGRect.zero)
- self.bodyLabel = UILabel(frame: CGRect.zero)
- self.thumbnailView = UIImageView(frame: CGRect.zero)
-
- super.init(style: style, reuseIdentifier: reuseIdentifier)
-
- self.selectionStyle = UITableViewCellSelectionStyle.None
- self.backgroundColor = UIColor.whiteColor()
- self.configureSubviews()
- }
-
- required public init?(coder aDecoder: NSCoder) {
- fatalError("init(coder:) has not been implemented")
- }
-
- override public func prepareForReuse() {
- self.selectionStyle = UITableViewCellSelectionStyle.None
- self.titleLabel.font = UIFont.boldSystemFontOfSize(MessageTableViewCell.defaultFontSize)
- self.bodyLabel.font = UIFont.boldSystemFontOfSize(13)
- self.titleLabel.text = ""
- self.bodyLabel.text = ""
- }
-
- func configureSubviews() {
- self.titleLabel.translatesAutoresizingMaskIntoConstraints = false
- self.titleLabel.backgroundColor = UIColor.clearColor()
- self.titleLabel.userInteractionEnabled = false
- self.titleLabel.numberOfLines = 0
- self.titleLabel.textColor = UIColor.grayColor()
- self.titleLabel.font = UIFont.boldSystemFontOfSize(MessageTableViewCell.defaultFontSize)
-
- self.bodyLabel.translatesAutoresizingMaskIntoConstraints = false
- self.bodyLabel.backgroundColor = UIColor.clearColor()
- self.bodyLabel.userInteractionEnabled = false
- self.bodyLabel.numberOfLines = 0
- self.bodyLabel.textColor = UIColor.grayColor()
- self.bodyLabel.font = UIFont.boldSystemFontOfSize(13)
-
- self.thumbnailView.translatesAutoresizingMaskIntoConstraints = false
- self.thumbnailView.userInteractionEnabled = false
- self.thumbnailView.backgroundColor = UIColor(white: 0.9, alpha: 1.0)
- self.thumbnailView.layer.cornerRadius = 15
- self.thumbnailView.layer.masksToBounds = true
-
- self.contentView.addSubview(self.thumbnailView)
- self.contentView.addSubview(self.titleLabel)
- self.contentView.addSubview(self.bodyLabel)
-
- let views = ["thumbnailView":self.thumbnailView, "titleLabel":self.titleLabel, "bodyLabel":self.bodyLabel]
- let metrics = ["thumbSize":MessageTableViewCell.kMessageTableViewCellAvatarHeight, "padding":15, "right":10, "left":5]
-
- self.contentView.addConstraints(NSLayoutConstraint.constraintsWithVisualFormat("H:|-left-[thumbnailView(thumbSize)]-right-[titleLabel(>=0)]-right-|", options: NSLayoutFormatOptions(rawValue: 0), metrics: metrics, views: views))
- self.contentView.addConstraints(NSLayoutConstraint.constraintsWithVisualFormat("H:|-left-[thumbnailView(thumbSize)]-right-[bodyLabel(>=0)]-right-|", options: NSLayoutFormatOptions(rawValue: 0), metrics: metrics, views: views))
- self.contentView.addConstraints(NSLayoutConstraint.constraintsWithVisualFormat("V:|-right-[titleLabel(20)]-left-[bodyLabel(>=0@999)]-left-|", options: NSLayoutFormatOptions(rawValue: 0), metrics: metrics, views: views))
- self.contentView.addConstraints(NSLayoutConstraint.constraintsWithVisualFormat("V:|-right-[thumbnailView(thumbSize)]-(>=0)-|", options: NSLayoutFormatOptions(rawValue: 0), metrics: metrics, views: views))
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/MessageTextView.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/MessageTextView.swift b/sdks/swift/Samples/ActivityFeed/Source/MessageTextView.swift
deleted file mode 100644
index 135372e..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/MessageTextView.swift
+++ /dev/null
@@ -1,39 +0,0 @@
-//
-// MessageTextView.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 11/24/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import SlackTextViewController
-
-class MessageTextView : SLKTextView {
- override func willMoveToSuperview(newSuperview: UIView?) {
- super.willMoveToSuperview(newSuperview)
- self.backgroundColor = UIColor.whiteColor()
- self.placeholderColor = UIColor.lightGrayColor()
- self.placeholder = "Message"
- self.pastableMediaTypes = .None
- self.layer.borderColor = UIColor(red: 217/255, green: 217/255, blue: 217/255, alpha: 1.0).CGColor
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/MessageViewController.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/MessageViewController.swift b/sdks/swift/Samples/ActivityFeed/Source/MessageViewController.swift
deleted file mode 100644
index b2a152c..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/MessageViewController.swift
+++ /dev/null
@@ -1,224 +0,0 @@
-//
-// MessageViewController.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 1/21/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import UsergridSDK
-import SlackTextViewController
-import WatchConnectivity
-
-class MessageViewController : SLKTextViewController {
-
- static let MESSAGE_CELL_IDENTIFIER = "MessengerCell"
-
- private var messageEntities: [ActivityEntity] = []
-
- init() {
- super.init(tableViewStyle:.Plain)
- commonInit()
- }
-
- required init(coder decoder: NSCoder) {
- super.init(coder: decoder)
- commonInit()
- }
-
- override static func tableViewStyleForCoder(decoder: NSCoder) -> UITableViewStyle {
- return .Plain
- }
-
- override func viewWillAppear(animated: Bool) {
- self.reloadMessages()
- if let username = Usergrid.currentUser?.name {
- self.navigationItem.title = "\(username)'s Feed"
- }
- super.viewWillAppear(animated)
- }
-
- func commonInit() {
- self.bounces = true
- self.shakeToClearEnabled = true
- self.keyboardPanningEnabled = true
- self.shouldScrollToBottomAfterKeyboardShows = true
- self.inverted = true
-
- self.registerClassForTextView(MessageTextView)
- self.activateWCSession()
- }
-
- func reloadMessages() {
- UsergridManager.getFeedMessages { (response) -> Void in
- self.messageEntities = response.entities as? [ActivityEntity] ?? []
- self.tableView!.reloadData()
- }
- }
-
- override func viewDidLoad() {
- super.viewDidLoad()
-
- self.rightButton.setTitle("Send", forState: .Normal)
-
- self.textInputbar.autoHideRightButton = true
- self.textInputbar.maxCharCount = 256
- self.textInputbar.editorTitle.textColor = UIColor.darkGrayColor()
-
- self.tableView!.separatorStyle = .None
- self.tableView!.registerClass(MessageTableViewCell.self, forCellReuseIdentifier:MessageViewController.MESSAGE_CELL_IDENTIFIER)
- }
-
- override func didPressRightButton(sender: AnyObject!) {
- self.textView.refreshFirstResponder()
-
- UsergridManager.postFeedMessage(self.textView.text) { (response) -> Void in
- if let messageEntity = response.entity as? ActivityEntity {
- let indexPath = NSIndexPath(forRow: 0, inSection: 0)
- let rowAnimation: UITableViewRowAnimation = self.inverted ? .Bottom : .Top
- let scrollPosition: UITableViewScrollPosition = self.inverted ? .Bottom : .Top
-
- self.tableView!.beginUpdates()
- self.messageEntities.insert(messageEntity, atIndex: 0)
- self.tableView!.insertRowsAtIndexPaths([indexPath], withRowAnimation: rowAnimation)
- self.tableView!.endUpdates()
-
- self.tableView!.scrollToRowAtIndexPath(indexPath, atScrollPosition: scrollPosition, animated: true)
- self.tableView!.reloadRowsAtIndexPaths([indexPath], withRowAnimation: .Automatic)
-
- self.sendEntitiesToWatch(self.messageEntities)
- }
- }
- super.didPressRightButton(sender)
- }
-
- override func keyForTextCaching() -> String? {
- return NSBundle.mainBundle().bundleIdentifier
- }
-
- override func numberOfSectionsInTableView(tableView: UITableView) -> Int {
- return 1
- }
-
- override func tableView(tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
- return self.messageEntities.count
- }
-
- override func tableView(tableView: UITableView, cellForRowAtIndexPath indexPath: NSIndexPath) -> UITableViewCell {
- return self.messageCellForRowAtIndexPath(indexPath)
- }
-
- @IBAction func unwindToChat(segue: UIStoryboardSegue) {
-
- }
-
- func populateCell(cell:MessageTableViewCell,feedEntity:ActivityEntity) {
-
- cell.titleLabel.text = feedEntity.displayName
- cell.bodyLabel.text = feedEntity.content
- cell.thumbnailView.image = nil
-
- if let imageURLString = feedEntity.imageURL, imageURL = NSURL(string: imageURLString) {
- NSURLSession.sharedSession().dataTaskWithURL(imageURL) { (data, response, error) in
- if let imageData = data, image = UIImage(data: imageData) {
- dispatch_async(dispatch_get_main_queue(), { () -> Void in
- cell.thumbnailView.image = image
- })
- }
- }.resume()
- }
- }
-
- func messageCellForRowAtIndexPath(indexPath:NSIndexPath) -> MessageTableViewCell {
- let cell = self.tableView!.dequeueReusableCellWithIdentifier(MessageViewController.MESSAGE_CELL_IDENTIFIER) as! MessageTableViewCell
- self.populateCell(cell, feedEntity: self.messageEntities[indexPath.row])
-
- cell.indexPath = indexPath
- cell.transform = self.tableView!.transform
-
- return cell
- }
-
- override func tableView(tableView: UITableView, heightForRowAtIndexPath indexPath: NSIndexPath) -> CGFloat {
-
- let feedEntity = messageEntities[indexPath.row]
-
- guard let messageText = feedEntity.content where !messageText.isEmpty
- else {
- return 0
- }
-
- let messageUsername : NSString = feedEntity.displayName ?? ""
-
- let paragraphStyle = NSMutableParagraphStyle()
- paragraphStyle.lineBreakMode = .ByWordWrapping
- paragraphStyle.alignment = .Left
-
- let pointSize = MessageTableViewCell.defaultFontSize
- let attributes = [NSFontAttributeName:UIFont.boldSystemFontOfSize(pointSize),NSParagraphStyleAttributeName:paragraphStyle]
-
- let width: CGFloat = CGRectGetWidth(self.tableView!.frame) - MessageTableViewCell.kMessageTableViewCellAvatarHeight - 25
-
- let titleBounds = messageUsername.boundingRectWithSize(CGSize(width: width, height: CGFloat.max), options: .UsesLineFragmentOrigin, attributes: attributes, context: nil)
- let bodyBounds = messageText.boundingRectWithSize(CGSize(width: width, height: CGFloat.max), options: .UsesLineFragmentOrigin, attributes: attributes, context: nil)
-
- var height = CGRectGetHeight(titleBounds) + CGRectGetHeight(bodyBounds) + 40
- if height < MessageTableViewCell.kMessageTableViewCellMinimumHeight {
- height = MessageTableViewCell.kMessageTableViewCellMinimumHeight
- }
-
- return height
- }
-}
-
-extension MessageViewController : WCSessionDelegate {
-
- func activateWCSession() {
- if (WCSession.isSupported()) {
- let session = WCSession.defaultSession()
- session.delegate = self
- session.activateSession()
- }
- }
-
- func sendEntitiesToWatch(messages:[UsergridEntity]) {
- if WCSession.defaultSession().reachable {
- NSKeyedArchiver.setClassName("ActivityEntity", forClass: ActivityEntity.self)
- let data = NSKeyedArchiver.archivedDataWithRootObject(messages)
- WCSession.defaultSession().sendMessageData(data, replyHandler: nil, errorHandler: { (error) -> Void in
- self.showAlert(title: "WCSession Unreachable.", message: "\(error)")
- })
- }
- }
-
- func session(session: WCSession, didReceiveMessage message: [String : AnyObject]) {
- if let action = message["action"] as? String where action == "getMessages" {
- UsergridManager.getFeedMessages { (response) -> Void in
- if let entities = response.entities {
- self.sendEntitiesToWatch(entities)
- }
- }
- }
- }
-
-}
-
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/RegisterViewController.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/RegisterViewController.swift b/sdks/swift/Samples/ActivityFeed/Source/RegisterViewController.swift
deleted file mode 100644
index 25cad11..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/RegisterViewController.swift
+++ /dev/null
@@ -1,62 +0,0 @@
-//
-// RegisterViewController.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 1/21/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import UIKit
-import UsergridSDK
-
-class RegisterViewController: UIViewController {
-
- @IBOutlet weak var nameTextField: UITextField!
- @IBOutlet weak var usernameTextField: UITextField!
- @IBOutlet weak var emailTextField: UITextField!
- @IBOutlet weak var passwordTextField: UITextField!
-
- @IBAction func registerButtonTouched(sender: AnyObject) {
- guard let name = nameTextField.text where !name.isEmpty,
- let username = usernameTextField.text where !username.isEmpty,
- let email = emailTextField.text where !email.isEmpty,
- let password = passwordTextField.text where !password.isEmpty
- else {
- self.showAlert(title: "Error Registering User", message: "Name, username, email, and password fields must not be empty.")
- return;
- }
-
- self.createUser(name, username: username, email: email, password: password)
- }
-
- private func createUser(name:String, username:String, email:String, password:String) {
- UsergridManager.createUser(name, username: username, email: email, password: password) { (response) -> Void in
- if let createdUser = response.user {
- self.showAlert(title: "Registering User Successful", message: "User description: \n \(createdUser.stringValue)") { (action) -> Void in
- self.performSegueWithIdentifier("unwindSegue", sender: self)
- }
- } else {
- self.showAlert(title: "Error Registering User", message: response.error?.errorDescription)
- }
- }
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/UsergridManager.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/UsergridManager.swift b/sdks/swift/Samples/ActivityFeed/Source/UsergridManager.swift
deleted file mode 100644
index 99fe4b5..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/UsergridManager.swift
+++ /dev/null
@@ -1,78 +0,0 @@
-//
-// UsergridManager.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 1/19/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import UsergridSDK
-
-/// This class handles the primary communications to the UsergirdSDK.
-public class UsergridManager {
-
- static let ORG_ID = "rwalsh"
- static let APP_ID = "sandbox"
- static let NOTIFIER_ID = "usergridsample"
- static let BASE_URL = "https://api.usergrid.com"
-
- static func initializeSharedInstance() {
- Usergrid.initSharedInstance(configuration: UsergridClientConfig(orgId: UsergridManager.ORG_ID, appId: UsergridManager.APP_ID, baseUrl: UsergridManager.BASE_URL))
- ActivityEntity.registerSubclass()
- }
-
- static func loginUser(username:String, password:String, completion:UsergridUserAuthCompletionBlock) {
- let userAuth = UsergridUserAuth(username: username, password: password)
- Usergrid.authenticateUser(userAuth, completion: completion)
- }
-
- static func createUser(name:String, username:String, email:String, password:String, completion:UsergridResponseCompletion) {
- let user = UsergridUser(name: name, propertyDict: [UsergridUserProperties.Username.stringValue:username,
- UsergridUserProperties.Email.stringValue:email,
- UsergridUserProperties.Password.stringValue:password])
- user.create(completion)
- }
-
- static func getFeedMessages(completion:UsergridResponseCompletion) {
- Usergrid.GET(UsergridQuery("users/me/feed").desc(UsergridEntityProperties.Created.stringValue), queryCompletion: completion)
- }
-
- static func postFeedMessage(text:String,completion:UsergridResponseCompletion) {
- let currentUser = Usergrid.currentUser!
-
- let verb = "post"
- let content = text
-
- var actorDictionary = [String:AnyObject]()
- actorDictionary["displayName"] = currentUser.name ?? currentUser.usernameOrEmail ?? ""
- actorDictionary["email"] = currentUser.email ?? ""
- if let imageURL = currentUser.picture {
- actorDictionary["image"] = ["url":imageURL,"height":80,"width":80]
- }
-
- Usergrid.POST("users/me/activities", jsonBody: ["actor":actorDictionary,"verb":verb,"content":content], completion: completion)
- }
-
- static func followUser(username:String, completion:UsergridResponseCompletion) {
- Usergrid.connect("users", entityID: "me", relationship: "following", toType: "users", toName: username, completion: completion)
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Source/ViewControllerExtensions.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Source/ViewControllerExtensions.swift b/sdks/swift/Samples/ActivityFeed/Source/ViewControllerExtensions.swift
deleted file mode 100644
index ad79741..0000000
--- a/sdks/swift/Samples/ActivityFeed/Source/ViewControllerExtensions.swift
+++ /dev/null
@@ -1,36 +0,0 @@
-//
-// ViewControllerExtensions.swift
-// ActivityFeed
-//
-// Created by Robert Walsh on 11/19/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import UIKit
-
-extension UIViewController {
- func showAlert(title title: String, message: String?, handler:((UIAlertAction) -> Void)? = nil) {
- let alert = UIAlertController(title: title, message: message, preferredStyle: UIAlertControllerStyle.Alert)
- alert.addAction(UIAlertAction(title: "Close", style: UIAlertActionStyle.Default, handler: handler))
- self.presentViewController(alert, animated: true, completion: nil)
- }
-}
-
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/WatchSample Extension/Assets.xcassets/README__ignoredByTemplate__
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/WatchSample Extension/Assets.xcassets/README__ignoredByTemplate__ b/sdks/swift/Samples/ActivityFeed/WatchSample Extension/Assets.xcassets/README__ignoredByTemplate__
deleted file mode 100644
index b601d38..0000000
--- a/sdks/swift/Samples/ActivityFeed/WatchSample Extension/Assets.xcassets/README__ignoredByTemplate__
+++ /dev/null
@@ -1 +0,0 @@
-Did you know that git does not support storing empty directories?
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/WatchSample Extension/ExtensionDelegate.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/WatchSample Extension/ExtensionDelegate.swift b/sdks/swift/Samples/ActivityFeed/WatchSample Extension/ExtensionDelegate.swift
deleted file mode 100644
index 400495f..0000000
--- a/sdks/swift/Samples/ActivityFeed/WatchSample Extension/ExtensionDelegate.swift
+++ /dev/null
@@ -1,45 +0,0 @@
-//
-// ExtensionDelegate.swift
-// WatchSample Extension
-//
-// Created by Robert Walsh on 1/19/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-
-import WatchKit
-
-class ExtensionDelegate: NSObject, WKExtensionDelegate {
-
- func applicationDidFinishLaunching() {
- // Perform any final initialization of your application.
- }
-
- func applicationDidBecomeActive() {
- // Restart any tasks that were paused (or not yet started) while the application was inactive. If the application was previously in the background, optionally refresh the user interface.
- }
-
- func applicationWillResignActive() {
- // Sent when the application is about to move from active to inactive state. This can occur for certain types of temporary interruptions (such as an incoming phone call or SMS message) or when the user quits the application and it begins the transition to the background state.
- // Use this method to pause ongoing tasks, disable timers, etc.
- }
-
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/WatchSample Extension/Info.plist
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/WatchSample Extension/Info.plist b/sdks/swift/Samples/ActivityFeed/WatchSample Extension/Info.plist
deleted file mode 100644
index 8d0393f..0000000
--- a/sdks/swift/Samples/ActivityFeed/WatchSample Extension/Info.plist
+++ /dev/null
@@ -1,45 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
- <key>CFBundleDevelopmentRegion</key>
- <string>en</string>
- <key>CFBundleDisplayName</key>
- <string>WatchSample Extension</string>
- <key>CFBundleExecutable</key>
- <string>$(EXECUTABLE_NAME)</string>
- <key>CFBundleIdentifier</key>
- <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
- <key>CFBundleInfoDictionaryVersion</key>
- <string>6.0</string>
- <key>CFBundleName</key>
- <string>$(PRODUCT_NAME)</string>
- <key>CFBundlePackageType</key>
- <string>XPC!</string>
- <key>CFBundleShortVersionString</key>
- <string>1.0</string>
- <key>CFBundleSignature</key>
- <string>????</string>
- <key>CFBundleVersion</key>
- <string>1</string>
- <key>NSAppTransportSecurity</key>
- <dict>
- <key>NSAllowsArbitraryLoads</key>
- <true/>
- </dict>
- <key>NSExtension</key>
- <dict>
- <key>NSExtensionAttributes</key>
- <dict>
- <key>WKAppBundleIdentifier</key>
- <string>com.usergrid.activityfeed.watchkitapp</string>
- </dict>
- <key>NSExtensionPointIdentifier</key>
- <string>com.apple.watchkit</string>
- </dict>
- <key>RemoteInterfacePrincipalClass</key>
- <string>$(PRODUCT_MODULE_NAME).InterfaceController</string>
- <key>WKExtensionDelegateClassName</key>
- <string>$(PRODUCT_MODULE_NAME).ExtensionDelegate</string>
-</dict>
-</plist>
[37/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridEntity.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridEntity.html b/sdks/swift/docs/Classes/UsergridEntity.html
deleted file mode 100644
index 280138b..0000000
--- a/sdks/swift/docs/Classes/UsergridEntity.html
+++ /dev/null
@@ -1,2683 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridEntity 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/UsergridEntity" class="dashAnchor"></a>
- <a title="UsergridEntity 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" />
- UsergridEntity 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>UsergridEntity</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridEntity</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridEntity</code> is the base class that contains a single Usergrid entity. </p>
-
-<p><code>UsergridEntity</code> maintains a set of accessor properties for standard Usergrid schema properties (e.g. name, uuid), and supports helper methods for accessing any custom properties that might exist.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:iC11UsergridSDK14UsergridEntity9subscriptFSSGSqPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:iC11UsergridSDK14UsergridEntity9subscriptFSSGSqPs9AnyObject__">subscript(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Subscript for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> class.</p>
-
-<ul>
-<li>Example usage:
-<code>
-let propertyValue = usergridEntity["propertyName"]
-usergridEntity["propertyName"] = propertyValue
-</code></li>
-</ul>
-
- </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">subscript</span><span class="p">(</span><span class="nv">propertyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AnyObject</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="/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:vC11UsergridSDK14UsergridEntity5assetGSqCS_13UsergridAsset_"></a>
- <a name="//apple_ref/swift/Property/asset" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity5assetGSqCS_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 <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> that contains the asset 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">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">asset</span><span class="p">:</span> <span class="kt">UsergridAsset</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity12fileMetaDataGSqCS_20UsergridFileMetaData_"></a>
- <a name="//apple_ref/swift/Property/fileMetaData" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity12fileMetaDataGSqCS_20UsergridFileMetaData_">fileMetaData</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a></code> of this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">fileMetaData</span> <span class="p">:</span> <span class="kt">UsergridFileMetaData</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity4typeSS"></a>
- <a name="//apple_ref/swift/Property/type" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity4typeSS">type</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties10EntityTypeFMS0_S0_">UsergridEntityProperties.EntityType</a></code>.</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">type</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">EntityType</span><span class="p">)</span> <span class="k">as!</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:vC11UsergridSDK14UsergridEntity4uuidGSqSS_"></a>
- <a name="//apple_ref/swift/Property/uuid" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity4uuidGSqSS_">uuid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties4UUIDFMS0_S0_">UsergridEntityProperties.UUID</a></code>.</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">uuid</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">UUID</span><span class="p">)</span> <span class="k">as?</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:vC11UsergridSDK14UsergridEntity4nameGSqSS_"></a>
- <a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity4nameGSqSS_">name</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties4NameFMS0_S0_">UsergridEntityProperties.Name</a></code>.</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">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">Name</span><span class="p">)</span> <span class="k">as?</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:vC11UsergridSDK14UsergridEntity7createdGSqCSo6NSDate_"></a>
- <a name="//apple_ref/swift/Property/created" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity7createdGSqCSo6NSDate_">created</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties7CreatedFMS0_S0_">UsergridEntityProperties.Created</a></code>.</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">created</span><span class="p">:</span> <span class="kt">NSDate</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">Created</span><span class="p">)</span> <span class="k">as?</span> <span class="kt">NSDate</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity8modifiedGSqCSo6NSDate_"></a>
- <a name="//apple_ref/swift/Property/modified" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity8modifiedGSqCSo6NSDate_">modified</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties8ModifiedFMS0_S0_">UsergridEntityProperties.Modified</a></code>.</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">modified</span><span class="p">:</span> <span class="kt">NSDate</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">Modified</span><span class="p">)</span> <span class="k">as?</span> <span class="kt">NSDate</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity8locationGSqCSo10CLLocation_"></a>
- <a name="//apple_ref/swift/Property/location" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity8locationGSqCSo10CLLocation_">location</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties8LocationFMS0_S0_">UsergridEntityProperties.Location</a></code>.</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">location</span><span class="p">:</span> <span class="kt">CLLocation</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity10uuidOrNameGSqSS_"></a>
- <a name="//apple_ref/swift/Property/uuidOrName" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity10uuidOrNameGSqSS_">uuidOrName</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method to get the UUID or name of the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">uuid</span> <span class="p">??</span> <span class="k">self</span><span class="o">.</span><span class="n">name</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity6isUserSb"></a>
- <a name="//apple_ref/swift/Property/isUser" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity6isUserSb">isUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Tells you if this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> has a type of <code>user</code>.</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">isUser</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span> <span class="k">is</span> <span class="kt">UsergridUser</span> <span class="o">||</span> <span class="k">self</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="kt">UsergridUser</span><span class="o">.</span><span class="kt">USER_ENTITY_TYPE</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity8hasAssetSb"></a>
- <a name="//apple_ref/swift/Property/hasAsset" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity8hasAssetSb">hasAsset</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Tells you if there is an asset associated with this entity.</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">hasAsset</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="k">asset</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="o">||</span> <span class="k">self</span><span class="o">.</span><span class="n">fileMetaData</span><span class="p">?</span><span class="o">.</span><span class="n">contentLength</span> <span class="o">></span> <span class="mi">0</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity15jsonObjectValueGVs10DictionarySSPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Property/jsonObjectValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity15jsonObjectValueGVs10DictionarySSPs9AnyObject__">jsonObjectValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The JSON object value.</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">jsonObjectValue</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="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">properties</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The string value.</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">stringValue</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">NSString</span><span class="p">(</span><span class="nv">data</span><span class="p">:</span> <span class="k">try!</span> <span class="kt">NSJSONSerialization</span><span class="o">.</span><span class="nf">dataWithJSONObject</span><span class="p">(</span><span class="k">self</span><span class="o">.</span><span class="n">jsonObjectValue</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="o">.</span><span class="kt">PrettyPrinted</span><span class="p">),</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">NSUTF8StringEncoding</span><span class="p">)</span> <span class="k">as!</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:vC11UsergridSDK14UsergridEntity11descriptionSS"></a>
- <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity11descriptionSS">description</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The description.</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">override</span> <span class="k">var</span> <span class="nv">description</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:vC11UsergridSDK14UsergridEntity16debugDescriptionSS"></a>
- <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity16debugDescriptionSS">debugDescription</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The debug description.</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">override</span> <span class="k">var</span> <span class="nv">debugDescription</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:FC11UsergridSDK14UsergridEntitycFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a>
- <a name="//apple_ref/swift/Method/init(type:name:propertyDict:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntitycFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_">init(type:name:propertyDict:)</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/UsergridEntity.html">UsergridEntity</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">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">propertyDict</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></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The type associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional name associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>propertyDict</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional property dictionary that the <code>UsergridEntity</code> object will start out with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK14UsergridEntity13mapCustomTypeFTSS10toSubclassMS0__T_"></a>
- <a name="//apple_ref/swift/Method/mapCustomType(_:toSubclass:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK14UsergridEntity13mapCustomTypeFTSS10toSubclassMS0__T_">mapCustomType(_:toSubclass:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Used for custom mapping subclasses to a given <code><a href="../Classes/Usergrid.html">Usergrid</a></code> type.</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">static</span> <span class="kd">func</span> <span class="nf">mapCustomType</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span><span class="nv">toSubclass</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="o">.</span><span class="k">Type</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The type of the <code>Usergrid</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>toSubclass</em>
- </code>
- </td>
- <td>
- <div>
- <p>The subclass <code>UsergridEntity.Type</code> to map it to.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK14UsergridEntity6entityFT8jsonDictGVs10DictionarySSPs9AnyObject___GSqS0__"></a>
- <a name="//apple_ref/swift/Method/entity(jsonDict:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK14UsergridEntity6entityFT8jsonDictGVs10DictionarySSPs9AnyObject___GSqS0__">entity(jsonDict:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Class convenience constructor for creating <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects dynamically.</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">class</span> <span class="kd">func</span> <span class="nf">entity</span><span class="p">(</span><span class="n">jsonDict</span> <span class="nv">jsonDict</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="kt">UsergridEntity</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>jsonDict</em>
- </code>
- </td>
- <td>
- <div>
- <p>A valid JSON dictionary which must contain at the very least a value for the <code>type</code> key.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> object provided that the <code><a href="../Classes/UsergridEntity.html#/s:vC11UsergridSDK14UsergridEntity4typeSS">type</a></code> key within the dictionay exists. Otherwise nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK14UsergridEntity8entitiesFT9jsonArrayGSaGVs10DictionarySSPs9AnyObject____GSaS0__"></a>
- <a name="//apple_ref/swift/Method/entities(jsonArray:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK14UsergridEntity8entitiesFT9jsonArrayGSaGVs10DictionarySSPs9AnyObject____GSaS0__">entities(jsonArray:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Class convenience constructor for creating multiple <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects dynamically.</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">class</span> <span class="kd">func</span> <span class="nf">entities</span><span class="p">(</span><span class="n">jsonArray</span> <span class="nv">entitiesJSONArray</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="p">[</span><span class="kt">UsergridEntity</span><span class="p">]</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entitiesJSONArray</em>
- </code>
- </td>
- <td>
- <div>
- <p>An array which contains dictionaries that are used to create the <code>UsergridEntity</code> objects.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>An array of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</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:FC11UsergridSDK14UsergridEntitycFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntitycFT5coderCSo7NSCoder_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:FC11UsergridSDK14UsergridEntity15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity15encodeWithCoderFCSo7NSCoderT_">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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Property%20Manipulation"></a>
- <a name="//apple_ref/swift/Section/Property Manipulation" class="dashAnchor"></a>
- <a href="#/Property%20Manipulation">
- <h3 class="section-name">Property Manipulation</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity11putPropertyFTSS5valueGSqPs9AnyObject___T_"></a>
- <a name="//apple_ref/swift/Method/putProperty(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity11putPropertyFTSS5valueGSqPs9AnyObject___T_">putProperty(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates a properties value for the given property name.</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">putProperty</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span><span class="nv">value</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value to update to.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity13putPropertiesFGVs10DictionarySSPs9AnyObject__T_"></a>
- <a name="//apple_ref/swift/Method/putProperties(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity13putPropertiesFGVs10DictionarySSPs9AnyObject__T_">putProperties(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates a set of properties that are within the given properties dictionary.</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">putProperties</span><span class="p">(</span><span class="nv">properties</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">])</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>properties</em>
- </code>
- </td>
- <td>
- <div>
- <p>The property dictionary containing the properties names and values.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity14removePropertyFSST_"></a>
- <a name="//apple_ref/swift/Method/removeProperty(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity14removePropertyFSST_">removeProperty(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Removes the property for the given property name.</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">removeProperty</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity16removePropertiesFGSaSS_T_"></a>
- <a name="//apple_ref/swift/Method/removeProperties(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity16removePropertiesFGSaSS_T_">removeProperties(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Removes the properties with the names within the propertyNames array</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">removeProperties</span><span class="p">(</span><span class="nv">propertyNames</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>propertyNames</em>
- </code>
- </td>
- <td>
- <div>
- <p>An array of property names.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity6appendFTSS5valuePs9AnyObject__T_"></a>
- <a name="//apple_ref/swift/Method/append(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6appendFTSS5valuePs9AnyObject__T_">append(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Appends the given value to the end of the properties current value.</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">append</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value or an array of values to append.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity6insertFTSS5valuePs9AnyObject_5indexSi_T_"></a>
- <a name="//apple_ref/swift/Method/insert(_:value:index:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6insertFTSS5valuePs9AnyObject_5indexSi_T_">insert(_:value:index:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Inserts the given value at the given index within the properties current value.</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">insert</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">,</span> <span class="nv">index</span><span class="p">:</span><span class="kt">Int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>index</em>
- </code>
- </td>
- <td>
- <div>
- <p>The index to insert at.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value or an array of values to insert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity3popFSST_"></a>
- <a name="//apple_ref/swift/Method/pop(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity3popFSST_">pop(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Removes the last value of the properties current value.</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">pop</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity5shiftFSST_"></a>
- <a name="//apple_ref/swift/Method/shift(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity5shiftFSST_">shift(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Removes the first value of the properties current value.</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">shift</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/CRUD%20Convenience%20Methods"></a>
- <a name="//apple_ref/swift/Section/CRUD Convenience Methods" class="dashAnchor"></a>
- <a href="#/CRUD%20Convenience%20Methods">
- <h3 class="section-name">CRUD Convenience Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity6reloadFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/reload(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6reloadFTGSqFT8responseCS_16UsergridResponse_T___T_">reload(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a GET on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">reload</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the reloaded <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity6reloadFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/reload(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6reloadFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">reload(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a GET on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">reload</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use when reloading.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the reloaded <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity4saveFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/save(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity4saveFTGSqFT8responseCS_16UsergridResponse_T___T_">save(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a PUT (or POST if no UUID is found) on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">save</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the updated/saved <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity4saveFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/save(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity4saveFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">save(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a PUT (or POST if no UUID is found) on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">save</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use when saving.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the updated/saved <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
-
<TRUNCATED>
[19/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridEntity.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridEntity.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridEntity.html
deleted file mode 100644
index 280138b..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridEntity.html
+++ /dev/null
@@ -1,2683 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridEntity 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/UsergridEntity" class="dashAnchor"></a>
- <a title="UsergridEntity 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" />
- UsergridEntity 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>UsergridEntity</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridEntity</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridEntity</code> is the base class that contains a single Usergrid entity. </p>
-
-<p><code>UsergridEntity</code> maintains a set of accessor properties for standard Usergrid schema properties (e.g. name, uuid), and supports helper methods for accessing any custom properties that might exist.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:iC11UsergridSDK14UsergridEntity9subscriptFSSGSqPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:iC11UsergridSDK14UsergridEntity9subscriptFSSGSqPs9AnyObject__">subscript(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Subscript for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> class.</p>
-
-<ul>
-<li>Example usage:
-<code>
-let propertyValue = usergridEntity["propertyName"]
-usergridEntity["propertyName"] = propertyValue
-</code></li>
-</ul>
-
- </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">subscript</span><span class="p">(</span><span class="nv">propertyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AnyObject</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="/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:vC11UsergridSDK14UsergridEntity5assetGSqCS_13UsergridAsset_"></a>
- <a name="//apple_ref/swift/Property/asset" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity5assetGSqCS_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 <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> that contains the asset 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">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">asset</span><span class="p">:</span> <span class="kt">UsergridAsset</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity12fileMetaDataGSqCS_20UsergridFileMetaData_"></a>
- <a name="//apple_ref/swift/Property/fileMetaData" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity12fileMetaDataGSqCS_20UsergridFileMetaData_">fileMetaData</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a></code> of this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">fileMetaData</span> <span class="p">:</span> <span class="kt">UsergridFileMetaData</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity4typeSS"></a>
- <a name="//apple_ref/swift/Property/type" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity4typeSS">type</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties10EntityTypeFMS0_S0_">UsergridEntityProperties.EntityType</a></code>.</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">type</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">EntityType</span><span class="p">)</span> <span class="k">as!</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:vC11UsergridSDK14UsergridEntity4uuidGSqSS_"></a>
- <a name="//apple_ref/swift/Property/uuid" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity4uuidGSqSS_">uuid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties4UUIDFMS0_S0_">UsergridEntityProperties.UUID</a></code>.</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">uuid</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">UUID</span><span class="p">)</span> <span class="k">as?</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:vC11UsergridSDK14UsergridEntity4nameGSqSS_"></a>
- <a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity4nameGSqSS_">name</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties4NameFMS0_S0_">UsergridEntityProperties.Name</a></code>.</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">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">Name</span><span class="p">)</span> <span class="k">as?</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:vC11UsergridSDK14UsergridEntity7createdGSqCSo6NSDate_"></a>
- <a name="//apple_ref/swift/Property/created" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity7createdGSqCSo6NSDate_">created</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties7CreatedFMS0_S0_">UsergridEntityProperties.Created</a></code>.</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">created</span><span class="p">:</span> <span class="kt">NSDate</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">Created</span><span class="p">)</span> <span class="k">as?</span> <span class="kt">NSDate</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity8modifiedGSqCSo6NSDate_"></a>
- <a name="//apple_ref/swift/Property/modified" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity8modifiedGSqCSo6NSDate_">modified</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties8ModifiedFMS0_S0_">UsergridEntityProperties.Modified</a></code>.</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">modified</span><span class="p">:</span> <span class="kt">NSDate</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">getEntitySpecificProperty</span><span class="p">(</span><span class="o">.</span><span class="kt">Modified</span><span class="p">)</span> <span class="k">as?</span> <span class="kt">NSDate</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity8locationGSqCSo10CLLocation_"></a>
- <a name="//apple_ref/swift/Property/location" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity8locationGSqCSo10CLLocation_">location</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects <code><a href="../Enums/UsergridEntityProperties.html#/s:FO11UsergridSDK24UsergridEntityProperties8LocationFMS0_S0_">UsergridEntityProperties.Location</a></code>.</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">location</span><span class="p">:</span> <span class="kt">CLLocation</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity10uuidOrNameGSqSS_"></a>
- <a name="//apple_ref/swift/Property/uuidOrName" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity10uuidOrNameGSqSS_">uuidOrName</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method to get the UUID or name of the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">uuid</span> <span class="p">??</span> <span class="k">self</span><span class="o">.</span><span class="n">name</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity6isUserSb"></a>
- <a name="//apple_ref/swift/Property/isUser" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity6isUserSb">isUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Tells you if this <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> has a type of <code>user</code>.</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">isUser</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span> <span class="k">is</span> <span class="kt">UsergridUser</span> <span class="o">||</span> <span class="k">self</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="kt">UsergridUser</span><span class="o">.</span><span class="kt">USER_ENTITY_TYPE</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity8hasAssetSb"></a>
- <a name="//apple_ref/swift/Property/hasAsset" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity8hasAssetSb">hasAsset</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Tells you if there is an asset associated with this entity.</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">hasAsset</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="k">asset</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="o">||</span> <span class="k">self</span><span class="o">.</span><span class="n">fileMetaData</span><span class="p">?</span><span class="o">.</span><span class="n">contentLength</span> <span class="o">></span> <span class="mi">0</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity15jsonObjectValueGVs10DictionarySSPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Property/jsonObjectValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity15jsonObjectValueGVs10DictionarySSPs9AnyObject__">jsonObjectValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The JSON object value.</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">jsonObjectValue</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="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">properties</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridEntity11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The string value.</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">stringValue</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">NSString</span><span class="p">(</span><span class="nv">data</span><span class="p">:</span> <span class="k">try!</span> <span class="kt">NSJSONSerialization</span><span class="o">.</span><span class="nf">dataWithJSONObject</span><span class="p">(</span><span class="k">self</span><span class="o">.</span><span class="n">jsonObjectValue</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="o">.</span><span class="kt">PrettyPrinted</span><span class="p">),</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">NSUTF8StringEncoding</span><span class="p">)</span> <span class="k">as!</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:vC11UsergridSDK14UsergridEntity11descriptionSS"></a>
- <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity11descriptionSS">description</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The description.</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">override</span> <span class="k">var</span> <span class="nv">description</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:vC11UsergridSDK14UsergridEntity16debugDescriptionSS"></a>
- <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridEntity16debugDescriptionSS">debugDescription</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The debug description.</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">override</span> <span class="k">var</span> <span class="nv">debugDescription</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:FC11UsergridSDK14UsergridEntitycFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a>
- <a name="//apple_ref/swift/Method/init(type:name:propertyDict:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntitycFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_">init(type:name:propertyDict:)</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/UsergridEntity.html">UsergridEntity</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">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">propertyDict</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></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The type associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional name associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>propertyDict</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional property dictionary that the <code>UsergridEntity</code> object will start out with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK14UsergridEntity13mapCustomTypeFTSS10toSubclassMS0__T_"></a>
- <a name="//apple_ref/swift/Method/mapCustomType(_:toSubclass:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK14UsergridEntity13mapCustomTypeFTSS10toSubclassMS0__T_">mapCustomType(_:toSubclass:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Used for custom mapping subclasses to a given <code><a href="../Classes/Usergrid.html">Usergrid</a></code> type.</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">static</span> <span class="kd">func</span> <span class="nf">mapCustomType</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span><span class="nv">toSubclass</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="o">.</span><span class="k">Type</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The type of the <code>Usergrid</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>toSubclass</em>
- </code>
- </td>
- <td>
- <div>
- <p>The subclass <code>UsergridEntity.Type</code> to map it to.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK14UsergridEntity6entityFT8jsonDictGVs10DictionarySSPs9AnyObject___GSqS0__"></a>
- <a name="//apple_ref/swift/Method/entity(jsonDict:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK14UsergridEntity6entityFT8jsonDictGVs10DictionarySSPs9AnyObject___GSqS0__">entity(jsonDict:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Class convenience constructor for creating <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects dynamically.</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">class</span> <span class="kd">func</span> <span class="nf">entity</span><span class="p">(</span><span class="n">jsonDict</span> <span class="nv">jsonDict</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="kt">UsergridEntity</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>jsonDict</em>
- </code>
- </td>
- <td>
- <div>
- <p>A valid JSON dictionary which must contain at the very least a value for the <code>type</code> key.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> object provided that the <code><a href="../Classes/UsergridEntity.html#/s:vC11UsergridSDK14UsergridEntity4typeSS">type</a></code> key within the dictionay exists. Otherwise nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK14UsergridEntity8entitiesFT9jsonArrayGSaGVs10DictionarySSPs9AnyObject____GSaS0__"></a>
- <a name="//apple_ref/swift/Method/entities(jsonArray:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK14UsergridEntity8entitiesFT9jsonArrayGSaGVs10DictionarySSPs9AnyObject____GSaS0__">entities(jsonArray:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Class convenience constructor for creating multiple <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects dynamically.</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">class</span> <span class="kd">func</span> <span class="nf">entities</span><span class="p">(</span><span class="n">jsonArray</span> <span class="nv">entitiesJSONArray</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="p">[</span><span class="kt">UsergridEntity</span><span class="p">]</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entitiesJSONArray</em>
- </code>
- </td>
- <td>
- <div>
- <p>An array which contains dictionaries that are used to create the <code>UsergridEntity</code> objects.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>An array of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</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:FC11UsergridSDK14UsergridEntitycFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntitycFT5coderCSo7NSCoder_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:FC11UsergridSDK14UsergridEntity15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity15encodeWithCoderFCSo7NSCoderT_">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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Property%20Manipulation"></a>
- <a name="//apple_ref/swift/Section/Property Manipulation" class="dashAnchor"></a>
- <a href="#/Property%20Manipulation">
- <h3 class="section-name">Property Manipulation</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity11putPropertyFTSS5valueGSqPs9AnyObject___T_"></a>
- <a name="//apple_ref/swift/Method/putProperty(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity11putPropertyFTSS5valueGSqPs9AnyObject___T_">putProperty(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates a properties value for the given property name.</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">putProperty</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span><span class="nv">value</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value to update to.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity13putPropertiesFGVs10DictionarySSPs9AnyObject__T_"></a>
- <a name="//apple_ref/swift/Method/putProperties(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity13putPropertiesFGVs10DictionarySSPs9AnyObject__T_">putProperties(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates a set of properties that are within the given properties dictionary.</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">putProperties</span><span class="p">(</span><span class="nv">properties</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">])</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>properties</em>
- </code>
- </td>
- <td>
- <div>
- <p>The property dictionary containing the properties names and values.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity14removePropertyFSST_"></a>
- <a name="//apple_ref/swift/Method/removeProperty(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity14removePropertyFSST_">removeProperty(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Removes the property for the given property name.</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">removeProperty</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity16removePropertiesFGSaSS_T_"></a>
- <a name="//apple_ref/swift/Method/removeProperties(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity16removePropertiesFGSaSS_T_">removeProperties(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Removes the properties with the names within the propertyNames array</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">removeProperties</span><span class="p">(</span><span class="nv">propertyNames</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>propertyNames</em>
- </code>
- </td>
- <td>
- <div>
- <p>An array of property names.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity6appendFTSS5valuePs9AnyObject__T_"></a>
- <a name="//apple_ref/swift/Method/append(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6appendFTSS5valuePs9AnyObject__T_">append(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Appends the given value to the end of the properties current value.</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">append</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value or an array of values to append.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity6insertFTSS5valuePs9AnyObject_5indexSi_T_"></a>
- <a name="//apple_ref/swift/Method/insert(_:value:index:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6insertFTSS5valuePs9AnyObject_5indexSi_T_">insert(_:value:index:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Inserts the given value at the given index within the properties current value.</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">insert</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">,</span> <span class="nv">index</span><span class="p">:</span><span class="kt">Int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>index</em>
- </code>
- </td>
- <td>
- <div>
- <p>The index to insert at.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value or an array of values to insert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity3popFSST_"></a>
- <a name="//apple_ref/swift/Method/pop(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity3popFSST_">pop(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Removes the last value of the properties current value.</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">pop</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity5shiftFSST_"></a>
- <a name="//apple_ref/swift/Method/shift(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity5shiftFSST_">shift(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Removes the first value of the properties current value.</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">shift</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the property.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/CRUD%20Convenience%20Methods"></a>
- <a name="//apple_ref/swift/Section/CRUD Convenience Methods" class="dashAnchor"></a>
- <a href="#/CRUD%20Convenience%20Methods">
- <h3 class="section-name">CRUD Convenience Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity6reloadFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/reload(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6reloadFTGSqFT8responseCS_16UsergridResponse_T___T_">reload(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a GET on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">reload</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the reloaded <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity6reloadFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/reload(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity6reloadFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">reload(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a GET on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">reload</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use when reloading.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the reloaded <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity4saveFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/save(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity4saveFTGSqFT8responseCS_16UsergridResponse_T___T_">save(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a PUT (or POST if no UUID is found) on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">save</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the updated/saved <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridEntity4saveFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/save(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridEntity4saveFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">save(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a PUT (or POST if no UUID is found) on the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code>.</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">save</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use when saving.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the updated/saved <code>UsergridEntity</code> object.
<TRUNCATED>
[47/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridClient.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridClient.swift b/sdks/swift/Source/UsergridClient.swift
deleted file mode 100644
index 2b3eb6b..0000000
--- a/sdks/swift/Source/UsergridClient.swift
+++ /dev/null
@@ -1,931 +0,0 @@
-//
-// UsergridClient.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/3/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-
-import Foundation
-
-/**
-The `UsergridClient` class is the base handler for making client connections to and managing relationships with Usergrid's API.
-*/
-public class UsergridClient: NSObject, NSCoding {
-
- static let DEFAULT_BASE_URL = "https://api.usergrid.com"
-
- // MARK: - Instance Properties -
-
- lazy private var _requestManager: UsergridRequestManager = UsergridRequestManager(client: self)
-
- /// The configuration object used by the client.
- public let config: UsergridClientConfig
-
- /// The application identifier.
- public var appId : String { return config.appId }
-
- /// The organization identifier.
- public var orgId : String { return config.orgId }
-
- /// The base URL that all calls will be made with.
- public var baseUrl : String { return config.baseUrl }
-
- /// The constructed URL string based on the `UsergridClient`'s `baseUrl`, `orgId`, and `appId`.
- public var clientAppURL : String { return "\(baseUrl)/\(orgId)/\(appId)" }
-
- /// Whether or not the current user will be saved and restored from the keychain.
- public var persistCurrentUserInKeychain: Bool {
- get { return config.persistCurrentUserInKeychain }
- set(persist) { config.persistCurrentUserInKeychain = persist }
- }
-
- /// The currently logged in `UsergridUser`.
- internal(set) public var currentUser: UsergridUser? = nil {
- didSet {
- if persistCurrentUserInKeychain {
- if let newUser = self.currentUser {
- UsergridUser.saveCurrentUserKeychainItem(self,currentUser:newUser)
- } else if oldValue != nil {
- UsergridUser.deleteCurrentUserKeychainItem(self)
- }
- }
- }
- }
-
- /// The `UsergridUserAuth` which consists of the token information from the `currentUser` property.
- public var userAuth: UsergridUserAuth? { return currentUser?.auth }
-
- /// The temporary `UsergridAuth` object that is set when calling the `UsergridClient.usingAuth()` method.
- private var tempAuth: UsergridAuth? = nil
-
- /// The application level `UsergridAppAuth` object. Can be set manually but must call `authenticateApp` to retrieve token.
- public var appAuth: UsergridAppAuth? {
- get { return config.appAuth }
- set(auth) { config.appAuth = auth }
- }
-
- /// The `UsergridAuthMode` value used to determine what type of token will be sent, if any.
- public var authMode: UsergridAuthMode {
- get { return config.authMode }
- set(mode) { config.authMode = mode }
- }
-
- // MARK: - Initialization -
-
- /**
- Initializes instances of `UsergridClient`.
-
- - parameter orgId: The organization identifier.
- - parameter appId: The application identifier.
-
- - returns: The new instance of `UsergridClient`.
- */
- public convenience init(orgId: String, appId:String) {
- self.init(configuration:UsergridClientConfig(orgId: orgId, appId: appId))
- }
-
- /**
- Initializes instances of `UsergridClient`.
-
- - parameter orgId: The organization identifier.
- - parameter appId: The application identifier.
- - parameter baseUrl: The base URL that all calls will be made with.
-
- - returns: The new instance of `UsergridClient`.
- */
- public convenience init(orgId: String, appId:String, baseUrl:String) {
- self.init(configuration:UsergridClientConfig(orgId: orgId, appId: appId, baseUrl:baseUrl))
- }
-
- /**
- Initializes instances of `UsergridClient`.
-
- - parameter configuration: The configuration for the client to be set up with.
-
- - returns: The new instance of `UsergridClient`.
- */
- public init(configuration:UsergridClientConfig) {
- self.config = configuration
- super.init()
- if persistCurrentUserInKeychain {
- self.currentUser = UsergridUser.getCurrentUserFromKeychain(self) // Attempt to get the current user from the saved keychain data.
- }
- UsergridDevice.sharedDevice.save(self)
- }
-
- // MARK: - NSCoding -
-
- /**
- NSCoding protocol initializer.
-
- - parameter aDecoder: The decoder.
-
- - returns: A decoded `UsergridClient` object.
- */
- public required init?(coder aDecoder: NSCoder) {
- guard let config = aDecoder.decodeObjectForKey("config") as? UsergridClientConfig
- else {
- self.config = UsergridClientConfig(orgId: "", appId: "")
- super.init()
- return nil
- }
-
- self.config = config
- super.init()
-
- if let currentUser = aDecoder.decodeObjectForKey("currentUser") as? UsergridUser {
- self.currentUser = currentUser
- } else {
- if persistCurrentUserInKeychain {
- self.currentUser = UsergridUser.getCurrentUserFromKeychain(self)
- }
- }
- UsergridDevice.sharedDevice.save(self)
- }
-
- /**
- NSCoding protocol encoder.
-
- - parameter aCoder: The encoder.
- */
- public func encodeWithCoder(aCoder: NSCoder) {
- aCoder.encodeObject(self.config, forKey: "config")
- aCoder.encodeObject(self.currentUser, forKey: "currentUser")
- }
-
- // MARK: - Device Registration/Push Notifications -
-
- /**
- Sets the push token for the given notifier ID and performs a PUT request to update the shared `UsergridDevice` instance.
-
- - parameter pushToken: The push token from Apple.
- - parameter notifierID: The Usergrid notifier ID.
- - parameter completion: The completion block.
- */
- public func applyPushToken(pushToken: NSData, notifierID: String, completion: UsergridResponseCompletion? = nil) {
- self.applyPushToken(UsergridDevice.sharedDevice, pushToken: pushToken, notifierID: notifierID, completion: completion)
- }
-
- /**
- Sets the push token for the given notifier ID and performs a PUT request to update the given `UsergridDevice` instance.
-
- - parameter device: The `UsergridDevice` object.
- - parameter pushToken: The push token from Apple.
- - parameter notifierID: The Usergrid notifier ID.
- - parameter completion: The completion block.
- */
- public func applyPushToken(device: UsergridDevice, pushToken: NSData, notifierID: String, completion: UsergridResponseCompletion? = nil) {
- device.applyPushToken(pushToken, notifierID: notifierID)
- self.PUT("devices", jsonBody: device.jsonObjectValue) { (response) in
- if let responseEntity = response.entity {
- device.copyInternalsFromEntity(responseEntity)
- }
- completion?(response: response)
- }
- }
-
- // MARK: - Authorization and User Management -
-
- /**
- Determines the `UsergridAuth` object that will be used for all outgoing requests made.
-
- If there is a valid temporary `UsergridAuth` set by the functions `usingAuth` or `usingToken` it will return that.
-
- If there is a `UsergridUser` logged in and the token of that user is valid then it will return that.
-
- Otherwise, if the `authMode` is `.App`, and the `UsergridAppAuth` of the client is set and the token is valid it will return that.
-
- - returns: The `UsergridAuth` if one is found or nil if not.
- */
- public func authForRequests() -> UsergridAuth? {
- var usergridAuth: UsergridAuth?
- if let tempAuth = self.tempAuth {
- if tempAuth.isValid {
- usergridAuth = tempAuth
- }
- self.tempAuth = nil
- } else {
- switch(self.authMode) {
- case .User:
- if let userAuth = self.userAuth where userAuth.isValid {
- usergridAuth = userAuth
- }
- break
- case .App:
- if let appAuth = self.appAuth where appAuth.isValid {
- usergridAuth = appAuth
- }
- break
- case .None:
- usergridAuth = nil
- break
- }
- }
- return usergridAuth
- }
-
- /**
- Sets the client's `tempAuth` property using the passed in `UsergridAuth`.
-
- This will cause the next CRUD method performed by the client to use the `tempAuth` property once and will then reset.
-
- - parameter auth: The `UsergridAuth` object to temporarily use for authentication.
-
- - returns: `Self`
- */
- public func usingAuth(auth:UsergridAuth) -> Self {
- self.tempAuth = auth
- return self
- }
-
- /**
- Sets the client's `tempAuth` property using the passed in token.
-
- This will cause the next CRUD method performed by the client to use the `tempAuth` property once and will then reset.
-
- - parameter auth: The access token to temporarily use for authentication.
-
- - returns: `Self`
- */
- public func usingToken(token:String) -> Self {
- self.tempAuth = UsergridAuth(accessToken: token)
- return self
- }
-
- /**
- Authenticates with the `UsergridAppAuth` that is contained this instance of `UsergridCient`.
-
- - parameter completion: The completion block that will be called after authentication has completed.
- */
- public func authenticateApp(completion: UsergridAppAuthCompletionBlock? = nil) {
- guard let appAuth = self.appAuth
- else {
- let error = UsergridResponseError(errorName: "Invalid UsergridAppAuth.", errorDescription: "UsergridClient's appAuth is nil.")
- completion?(auth: nil, error: error)
- return
- }
- self.authenticateApp(appAuth, completion: completion)
- }
-
- /**
- Authenticates with the `UsergridAppAuth` that is passed in.
-
- - parameter auth: The `UsergridAppAuth` that will be authenticated.
- - parameter completion: The completion block that will be called after authentication has completed.
- */
- public func authenticateApp(appAuth: UsergridAppAuth, completion: UsergridAppAuthCompletionBlock? = nil) {
- let request = UsergridRequest(method: .Post,
- baseUrl: self.clientAppURL,
- paths: ["token"],
- auth: self.authForRequests(),
- jsonBody: appAuth.credentialsJSONDict)
-
- _requestManager.performAppAuthRequest(appAuth, request: request) { [weak self] (auth,error) in
- self?.appAuth = auth
- completion?(auth: auth, error: error)
- }
- }
-
- /**
- Authenticates with the `UsergridUserAuth` that is passed in.
-
- - parameter auth: The `UsergridUserAuth` that will be authenticated.
- - parameter completion: The completion block that will be called after authentication has completed.
- */
- public func authenticateUser(userAuth: UsergridUserAuth, completion: UsergridUserAuthCompletionBlock? = nil) {
- self.authenticateUser(userAuth, setAsCurrentUser:true, completion:completion)
- }
-
- /**
- Authenticates with the `UsergridUserAuth` that is passed in.
-
- - parameter auth: The `UsergridUserAuth` that will be authenticated.
- - parameter setAsCurrentUser: If the authenticated user should be set as the `UsergridClient.currentUser`.
- - parameter completion: The completion block that will be called after authentication has completed.
- */
- public func authenticateUser(userAuth: UsergridUserAuth, setAsCurrentUser: Bool, completion: UsergridUserAuthCompletionBlock? = nil) {
- let request = UsergridRequest(method: .Post,
- baseUrl: self.clientAppURL,
- paths: ["token"],
- auth: self.authForRequests(),
- jsonBody: userAuth.credentialsJSONDict)
- _requestManager.performUserAuthRequest(userAuth, request: request) { [weak self] (auth,user,error) in
- if setAsCurrentUser {
- self?.currentUser = user
- }
- completion?(auth: auth, user: user, error: error)
- }
- }
-
- /**
- Changes the given `UsergridUser`'s current password.
-
- - parameter user: The user.
- - parameter old: The old password.
- - parameter new: The new password.
- - parameter completion: The optional completion block.
- */
- public func resetPassword(user: UsergridUser, old:String, new:String, completion:UsergridUserResetPasswordCompletion? = nil) {
- guard let usernameOrEmail = user.usernameOrEmail
- else {
- completion?(error: UsergridResponseError(errorName: "Error resetting password.", errorDescription: "The UsergridUser object must contain a valid username or email to reset the password."), didSucceed: false)
- return
- }
-
- let request = UsergridRequest(method: .Put,
- baseUrl: self.clientAppURL,
- paths: ["users",usernameOrEmail,"password"],
- auth: self.authForRequests(),
- jsonBody:["oldpassword":old,"newpassword":new])
-
- _requestManager.performRequest(request, completion: { (response) -> Void in
- completion?(error: response.error, didSucceed: response.statusCode == 200)
- })
- }
-
- /**
- Logs out the current user locally and remotely.
-
- - parameter completion: The completion block that will be called after logout has completed.
- */
- public func logoutCurrentUser(completion:UsergridResponseCompletion? = nil) {
- guard let uuidOrUsername = self.currentUser?.uuidOrUsername,
- let token = self.currentUser?.auth?.accessToken
- else {
- completion?(response:UsergridResponse(client: self, errorName: "Logout Failed.", errorDescription: "UsergridClient's currentUser is not valid."))
- return
- }
-
- self.logoutUser(uuidOrUsername, token: token)
- }
-
- /**
- Logs out the user remotely with the given tokens.
-
- - parameter completion: The completion block that will be called after logout has completed.
- */
- public func logoutUserAllTokens(uuidOrUsername:String, completion:UsergridResponseCompletion? = nil) {
- self.logoutUser(uuidOrUsername, token: nil, completion: completion)
- }
-
- /**
- Logs out a user with the give UUID or username using the shared instance of `UsergridCient`.
-
- Passing in a token will log out the user for just that token. Passing in nil for the token will logout the user for all tokens.
-
- - parameter completion: The completion block that will be called after logout has completed.
- */
- public func logoutUser(uuidOrUsername:String, token:String?, completion:UsergridResponseCompletion? = nil) {
- var paths = ["users",uuidOrUsername]
- var queryParams: [String: String]?
- if let accessToken = token {
- paths.append("revoketoken")
- queryParams = ["token": accessToken]
- } else {
- paths.append("revoketokens")
- }
- let request = UsergridRequest(method: .Put,
- baseUrl: self.clientAppURL,
- paths: paths,
- auth: self.authForRequests(),
- queryParams: queryParams)
-
- self.sendRequest(request) { response in
- if uuidOrUsername == self.currentUser?.uuidOrUsername { // Check to see if this user is the currentUser
- if response.ok || response.error?.errorName == "auth_bad_access_token" { // If the logout was successful or if we have a bad token reset things.
- self.currentUser?.auth = nil
- self.currentUser = nil
- }
- }
- completion?(response: response)
- }
- }
-
- // MARK: - Generic Request Methods -
-
- /**
- Starts the `UsergridRequest` sending process.
-
- - Note: This method should only be used when you construct your own `UsergridRequest` objects.
-
- - parameter request: The `UsergridRequest` object to send.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func sendRequest(request:UsergridRequest, completion:UsergridResponseCompletion? = nil) {
- _requestManager.performRequest(request, completion: completion)
- }
-
- // MARK: - GET -
-
- /**
- Gets a single `UsergridEntity` of a given type with a specific UUID/name.
-
- - parameter type: The `UsergridEntity` type.
- - parameter uuidOrName: The UUID or name of the `UsergridEntity`.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func GET(type: String, uuidOrName: String, completion: UsergridResponseCompletion? = nil) {
- let request = UsergridRequest(method: .Get, baseUrl: self.clientAppURL, paths: [type,uuidOrName], auth:self.authForRequests())
- self.sendRequest(request, completion: completion)
- }
-
- /**
- Gets a group of `UsergridEntity` objects of a given type.
-
- - parameter type: The `UsergridEntity` type.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func GET(type: String, completion: UsergridResponseCompletion? = nil) {
- let request = UsergridRequest(method: .Get, baseUrl: self.clientAppURL, paths: [type], query: nil, auth: self.authForRequests())
- self.sendRequest(request, completion: completion)
- }
-
- /**
- Gets a group of `UsergridEntity` objects using a given query.
-
- - parameter query: The query to use when gathering `UsergridEntity` objects.
- - parameter queryCompletion: The optional completion block that will be called once the request has completed.
- */
- public func GET(query: UsergridQuery, queryCompletion: UsergridResponseCompletion? = nil) {
- guard let type = query.collectionName
- else {
- queryCompletion?(response: UsergridResponse(client:self, errorName: "Query collection name missing.", errorDescription: "Query collection name is missing."))
- return
- }
-
- let request = UsergridRequest(method: .Get, baseUrl: self.clientAppURL, paths: [type], query: query, auth: self.authForRequests())
- self.sendRequest(request, completion: queryCompletion)
- }
-
- // MARK: - PUT -
-
- /**
- Updates an `UsergridEntity` with the given type and UUID/name specified using the passed in jsonBody.
-
- - parameter type: The `UsergridEntity` type.
- - parameter uuidOrName: The UUID or name of the `UsergridEntity`.
- - parameter jsonBody: The valid JSON body dictionary to update the `UsergridEntity` with.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func PUT(type: String, uuidOrName: String, jsonBody:[String:AnyObject], completion: UsergridResponseCompletion? = nil) {
- let request = UsergridRequest(method: .Put,
- baseUrl: self.clientAppURL,
- paths: [type,uuidOrName],
- auth: self.authForRequests(),
- headers: UsergridRequest.JSON_CONTENT_TYPE_HEADER,
- jsonBody: jsonBody)
- self.sendRequest(request, completion: completion)
- }
-
- /**
- Updates the passed in `UsergridEntity`.
-
- - parameter entity: The `UsergridEntity` to update.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func PUT(entity: UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- PUT(entity.type, jsonBody: entity.jsonObjectValue, completion: completion)
- }
-
- /**
- Updates an `UsergridEntity` with the given type using the jsonBody where the UUID/name is specified inside of the jsonBody.
-
- - Note: The `jsonBody` must contain a valid value for either `uuid` or `name` keys.
-
- - parameter type: The `UsergridEntity` type.
- - parameter jsonBody: The valid JSON body dictionary to update the `UsergridEntity` with.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func PUT(type: String, jsonBody:[String:AnyObject], completion: UsergridResponseCompletion? = nil) {
- guard let uuidOrName = (jsonBody[UsergridEntityProperties.UUID.stringValue] ?? jsonBody[UsergridEntityProperties.Name.stringValue]) as? String
- else {
- completion?(response: UsergridResponse(client:self, errorName: "jsonBody not valid.", errorDescription: "The `jsonBody` must contain a valid value for either `uuid` or `name`."))
- return
- }
- let request = UsergridRequest(method: .Put,
- baseUrl: self.clientAppURL,
- paths: [type,uuidOrName],
- auth: self.authForRequests(),
- headers: UsergridRequest.JSON_CONTENT_TYPE_HEADER,
- jsonBody: jsonBody)
- self.sendRequest(request, completion: completion)
- }
-
- /**
- Updates the entities that fit the given query using the passed in jsonBody.
-
- - Note: The query parameter must have a valid `collectionName` before calling this method.
-
- - parameter query: The query to use when filtering what entities to update.
- - parameter jsonBody: The valid JSON body dictionary to update with.
- - parameter queryCompletion: The optional completion block that will be called once the request has completed.
- */
- public func PUT(query: UsergridQuery, jsonBody:[String:AnyObject], queryCompletion: UsergridResponseCompletion? = nil) {
- guard let type = query.collectionName
- else {
- queryCompletion?(response: UsergridResponse(client:self, errorName: "Query collection name invalid.", errorDescription: "Query is missing a collection name."))
- return
- }
- let request = UsergridRequest(method: .Put,
- baseUrl: self.clientAppURL,
- paths: [type],
- query: query,
- auth: self.authForRequests(),
- headers: UsergridRequest.JSON_CONTENT_TYPE_HEADER,
- jsonBody: jsonBody)
- self.sendRequest(request, completion: queryCompletion)
- }
-
- // MARK: - POST -
-
- /**
- Creates and posts creates an `UsergridEntity`.
- - parameter entity: The `UsergridEntity` to create.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func POST(entity:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- let request = UsergridRequest(method: .Post,
- baseUrl: self.clientAppURL,
- paths: [entity.type],
- auth: self.authForRequests(),
- headers: UsergridRequest.JSON_CONTENT_TYPE_HEADER,
- jsonBody: entity.jsonObjectValue)
- self.sendRequest(request, completion: completion)
- }
-
- /**
- Creates and posts an array of `UsergridEntity` objects.
-
- - Note: Each `UsergridEntity` in the array much already have a type assigned and must be the same.
-
- - parameter entities: The `UsergridEntity` objects to create.
- - parameter entitiesCompletion: The optional completion block that will be called once the request has completed.
- */
- public func POST(entities:[UsergridEntity], entitiesCompletion: UsergridResponseCompletion? = nil) {
- guard let type = entities.first?.type
- else {
- entitiesCompletion?(response: UsergridResponse(client:self, errorName: "No type found.", errorDescription: "The first entity in the array had no type found."))
- return
- }
- POST(type, jsonBodies: entities.map { return ($0).jsonObjectValue }, completion: entitiesCompletion)
- }
-
- /**
- Creates and posts an `UsergridEntity` of the given type with the given jsonBody.
-
- - parameter type: The `UsergridEntity` type.
- - parameter jsonBody: The valid JSON body dictionary to use when creating the `UsergridEntity`.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func POST(type: String, jsonBody:[String:AnyObject], completion: UsergridResponseCompletion? = nil) {
- let request = UsergridRequest(method: .Post,
- baseUrl: self.clientAppURL,
- paths: [type],
- auth: self.authForRequests(),
- headers: UsergridRequest.JSON_CONTENT_TYPE_HEADER,
- jsonBody: jsonBody)
- self.sendRequest(request, completion: completion)
- }
-
- /**
- Creates and posts an array of `Entity` objects while assigning the given type to them.
-
- - parameter type: The `UsergridEntity` type.
- - parameter jsonBody: The valid JSON body dictionaries to use when creating the `UsergridEntity` objects.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func POST(type: String, jsonBodies:[[String:AnyObject]], completion: UsergridResponseCompletion? = nil) {
- let request = UsergridRequest(method: .Post,
- baseUrl: self.clientAppURL,
- paths: [type],
- auth: self.authForRequests(),
- headers: UsergridRequest.JSON_CONTENT_TYPE_HEADER,
- jsonBody: jsonBodies)
- self.sendRequest(request, completion: completion)
- }
-
- /**
- Creates and posts an `UsergridEntity` of the given type with a given name and the given jsonBody.
-
- - parameter type: The `UsergridEntity` type.
- - parameter name: The name of the `UsergridEntity`.
- - parameter jsonBody: The valid JSON body dictionary to use when creating the `UsergridEntity`.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func POST(type: String, name: String, jsonBody:[String:AnyObject], completion: UsergridResponseCompletion? = nil) {
- var jsonBodyWithName = jsonBody
- jsonBodyWithName[UsergridEntityProperties.Name.stringValue] = name
- let request = UsergridRequest(method: .Post,
- baseUrl: self.clientAppURL,
- paths: [type],
- auth: self.authForRequests(),
- headers: UsergridRequest.JSON_CONTENT_TYPE_HEADER,
- jsonBody: jsonBodyWithName)
- self.sendRequest(request, completion: completion)
-
- }
-
- // MARK: - DELETE -
-
- /**
- Destroys the passed `UsergridEntity`.
-
- - Note: The entity object must have a `uuid` or `name` assigned.
-
- - parameter entity: The `UsergridEntity` to delete.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func DELETE(entity:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- guard let uuidOrName = entity.uuidOrName
- else {
- completion?(response: UsergridResponse(client:self, errorName: "No UUID or name found.", errorDescription: "The entity object must have a `uuid` or `name` assigned."))
- return
- }
-
- DELETE(entity.type, uuidOrName: uuidOrName, completion: completion)
- }
-
- /**
- Destroys the `UsergridEntity` objects that fit the given `UsergridQuery`.
-
- - Note: The query parameter must have a valid `collectionName` before calling this method.
-
- - parameter query: The query to use when filtering what entities to delete.
- - parameter queryCompletion: The optional completion block that will be called once the request has completed.
- */
- public func DELETE(query:UsergridQuery, queryCompletion: UsergridResponseCompletion? = nil) {
- guard let type = query.collectionName
- else {
- queryCompletion?(response: UsergridResponse(client:self, errorName: "Query collection name invalid.", errorDescription: "Query is missing a collection name."))
- return
- }
-
- let request = UsergridRequest(method: .Delete,
- baseUrl: self.clientAppURL,
- paths: [type],
- query: query,
- auth: self.authForRequests(),
- headers: UsergridRequest.JSON_CONTENT_TYPE_HEADER)
- self.sendRequest(request, completion: queryCompletion)
- }
-
- /**
- Destroys the `UsergridEntity` of a given type with a specific UUID/name.
-
- - parameter type: The `UsergridEntity` type.
- - parameter uuidOrName: The UUID or name of the `UsergridEntity`.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func DELETE(type:String, uuidOrName: String, completion: UsergridResponseCompletion? = nil) {
- let request = UsergridRequest(method: .Delete,
- baseUrl: self.clientAppURL,
- paths: [type,uuidOrName],
- auth: self.authForRequests(),
- headers: UsergridRequest.JSON_CONTENT_TYPE_HEADER)
- self.sendRequest(request, completion: completion)
- }
-
- // MARK: - Connection Management -
-
- /**
- Connects the `UsergridEntity` objects via the relationship.
-
- - parameter entity: The `UsergridEntity` that will contain the connection.
- - parameter relationship: The relationship of the connection.
- - parameter to: The `UsergridEntity` which is connected.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func connect(entity:UsergridEntity, relationship:String, to:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- guard let entityID = entity.uuidOrName,
- let toID = to.uuidOrName
- else {
- completion?(response: UsergridResponse(client: self, errorName: "Invalid Entity Connection Attempt.", errorDescription: "One or both entities that are attempting to be connected do not contain a valid UUID or Name property."))
- return
- }
- self.connect(entity.type, entityID: entityID, relationship: relationship, toType: to.type, toID: toID, completion: completion)
- }
-
- /**
- Connects the entity objects via the relationship.
-
- - parameter entityType: The entity type.
- - parameter entityID: The entity UUID or name.
- - parameter relationship: The relationship of the connection.
- - parameter toType: The type of the entity you are connecting to.
- - parameter toName: The name of the entity you are connecting to.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func connect(entityType:String, entityID:String, relationship:String, toType:String, toName: String, completion: UsergridResponseCompletion? = nil) {
- self.connect(entityType, entityID: entityID, relationship: relationship, toType: toType, toID: toName, completion: completion)
- }
-
- /**
- Connects the entity objects via the relationship.
-
- - parameter entityType: The entity type.
- - parameter entityID: The entity UUID or name.
- - parameter relationship: The relationship of the connection.
- - parameter toType: The optional type of the entity you are connecting to.
- - parameter toID: The UUID of the entity you are connecting to.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func connect(entityType:String, entityID:String, relationship:String, toType:String?, toID: String, completion: UsergridResponseCompletion? = nil) {
- var paths = [entityType,entityID,relationship]
- if let toType = toType {
- paths.append(toType)
- }
- paths.append(toID)
-
- let request = UsergridRequest(method: .Post,
- baseUrl: self.clientAppURL,
- paths: paths,
- auth: self.authForRequests())
- self.sendRequest(request, completion: completion)
- }
-
- /**
- Disconnects the `UsergridEntity` objects via the relationship.
-
- - parameter entity: The `UsergridEntity` that contains the connection.
- - parameter relationship: The relationship of the connection.
- - parameter from: The `UsergridEntity` which is connected.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func disconnect(entity:UsergridEntity, relationship:String, from:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- guard let entityID = entity.uuidOrName,
- let fromID = from.uuidOrName
- else {
- completion?(response: UsergridResponse(client: self, errorName: "Invalid Entity Disconnect Attempt.", errorDescription: "The connecting and connected entities must have a `uuid` or `name` assigned."))
- return
- }
-
- self.disconnect(entity.type, entityID: entityID, relationship: relationship, fromType: from.type, fromID: fromID, completion: completion)
- }
-
- /**
- Disconnects the entity objects via the relationship.
-
- - parameter entityType: The entity type.
- - parameter entityID: The entity UUID or name.
- - parameter relationship: The relationship of the connection.
- - parameter fromType: The type of the entity you are disconnecting from.
- - parameter fromName: The name of the entity you are disconnecting from.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func disconnect(entityType:String, entityID:String, relationship:String, fromType:String, fromName: String, completion: UsergridResponseCompletion? = nil) {
- self.disconnect(entityType, entityID: entityID, relationship: relationship, fromType: fromType, fromID: fromName, completion: completion)
- }
-
- /**
- Disconnects the entity objects via the relationship.
-
- - parameter entityType: The entity type.
- - parameter entityID: The entity UUID or name.
- - parameter relationship: The relationship of the connection.
- - parameter fromType: The optional type of the entity you are disconnecting from.
- - parameter toID: The UUID of the entity you are disconnecting from.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func disconnect(entityType:String, entityID:String, relationship:String, fromType:String?, fromID: String, completion: UsergridResponseCompletion? = nil) {
-
- var paths = [entityType,entityID,relationship]
- if let fromType = fromType {
- paths.append(fromType)
- }
- paths.append(fromID)
-
- let request = UsergridRequest(method: .Delete,
- baseUrl: self.clientAppURL,
- paths: paths,
- auth: self.authForRequests())
- self.sendRequest(request, completion: completion)
- }
-
- /**
- Gets the connected entities for the given relationship.
-
- - parameter entity: The entity that contains the connection.
- - parameter relationship: The relationship of the connection.
- - parameter query: The optional query.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func getConnections(direction:UsergridDirection, entity:UsergridEntity, relationship:String, query:UsergridQuery? = nil, completion:UsergridResponseCompletion? = nil) {
- guard let uuidOrName = entity.uuidOrName
- else {
- completion?(response: UsergridResponse(client: self, errorName: "Invalid Entity Get Connections Attempt.", errorDescription: "The entity must have a `uuid` or `name` assigned."))
- return
- }
- self.getConnections(direction, type: entity.type, uuidOrName: uuidOrName, relationship: relationship, query:query, completion: completion)
- }
-
- /**
- Gets the connected entities for the given relationship.
-
- - parameter direction: The direction of the connection.
- - parameter type: The entity type.
- - parameter uuidOrName: The entity UUID or name.
- - parameter relationship: The relationship of the connection.
- - parameter query: The optional query.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func getConnections(direction:UsergridDirection, type:String, uuidOrName:String, relationship:String, query:UsergridQuery? = nil, completion:UsergridResponseCompletion? = nil) {
- let request = UsergridRequest(method: .Get,
- baseUrl: self.clientAppURL,
- paths: [type, uuidOrName, direction.connectionValue, relationship],
- query: query,
- auth: self.authForRequests())
- self.sendRequest(request, completion: completion)
- }
-
- /**
- Gets the connected entities for the given relationship.
-
- - parameter direction: The direction of the connection.
- - parameter uuid: The entity UUID.
- - parameter relationship: The relationship of the connection.
- - parameter query: The optional query.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func getConnections(direction:UsergridDirection, uuid:String, relationship:String, query:UsergridQuery? = nil, completion:UsergridResponseCompletion? = nil) {
- let request = UsergridRequest(method: .Get,
- baseUrl: self.clientAppURL,
- paths: [uuid, direction.connectionValue, relationship],
- query: query,
- auth: self.authForRequests())
- self.sendRequest(request, completion: completion)
- }
-
- // MARK: - Asset Management -
-
- /**
- Uploads the asset and connects the data to the given `UsergridEntity`.
-
- - parameter entity: The `UsergridEntity` to connect the asset to.
- - parameter asset: The `UsergridAsset` to upload.
- - parameter progress: The optional progress block that will be called to update the progress of the upload.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func uploadAsset(entity:UsergridEntity, asset:UsergridAsset, progress:UsergridAssetRequestProgress? = nil, completion:UsergridAssetUploadCompletion? = nil) {
- let assetRequest = UsergridAssetUploadRequest(baseUrl: self.clientAppURL,
- paths: [entity.type,entity.uuidOrName!],
- auth: self.authForRequests(),
- asset: asset)
-
- _requestManager.performAssetUpload(assetRequest, progress: progress) { asset, response in
- if response.ok {
- entity.asset = asset
- if let responseEntityFileMetaData = response.entity?.fileMetaData {
- entity.fileMetaData = responseEntityFileMetaData
- }
- }
- completion?(asset: asset, response: response)
- }
- }
-
- /**
- Downloads the asset from the given `UsergridEntity`.
-
- - parameter entity: The `UsergridEntity` to which the asset to.
- - parameter contentType: The content type of the asset's data.
- - parameter progress: The optional progress block that will be called to update the progress of the download.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public func downloadAsset(entity:UsergridEntity, contentType:String, progress:UsergridAssetRequestProgress? = nil, completion:UsergridAssetDownloadCompletion? = nil) {
- guard entity.hasAsset
- else {
- completion?(asset: nil, error: UsergridResponseError(errorName: "Download asset failed.", errorDescription: "Entity does not have an asset attached."))
- return
- }
-
- let downloadAssetRequest = UsergridRequest(method: .Get,
- baseUrl: self.clientAppURL,
- paths: [entity.type,entity.uuidOrName!],
- auth: self.authForRequests(),
- headers: ["Accept":contentType])
-
- _requestManager.performAssetDownload(contentType, usergridRequest: downloadAssetRequest, progress: progress, completion: { (asset, error) -> Void in
- entity.asset = asset
- completion?(asset: asset, error: error)
- })
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridClientConfig.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridClientConfig.swift b/sdks/swift/Source/UsergridClientConfig.swift
deleted file mode 100644
index 64ebd4f..0000000
--- a/sdks/swift/Source/UsergridClientConfig.swift
+++ /dev/null
@@ -1,149 +0,0 @@
-//
-// UsergridClientConfig.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 10/5/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-/**
-`UsergridClientConfig` is used when initializing `UsergridClient` objects.
-
-The `UsergridClientConfig` is meant for further customization of `UsergridClient` objects when needed.
-*/
-public class UsergridClientConfig : NSObject, NSCoding {
-
- // MARK: - Instance Properties -
-
- /// The organization identifier.
- public var orgId : String
-
- /// The application identifier.
- public var appId : String
-
- /// The base URL that all calls will be made with.
- public var baseUrl: String = UsergridClient.DEFAULT_BASE_URL
-
- /// The `UsergridAuthMode` value used to determine what type of token will be sent, if any.
- public var authMode: UsergridAuthMode = .User
-
- /// Whether or not the `UsergridClient` current user will be saved and restored from the keychain.
- public var persistCurrentUserInKeychain: Bool = true
-
- /**
- The application level `UsergridAppAuth` object.
-
- Note that you still need to call the authentication methods within `UsergridClient` once it has been initialized.
- */
- public var appAuth: UsergridAppAuth?
-
- // MARK: - Initialization -
-
- /**
- Designated initializer for `UsergridClientConfig` objects.
-
- - parameter orgId: The organization identifier.
- - parameter appId: The application identifier.
-
- - returns: A new instance of `UsergridClientConfig`.
- */
- public init(orgId: String, appId: String) {
- self.orgId = orgId
- self.appId = appId
- }
-
- /**
- Convenience initializer for `UsergridClientConfig`.
-
- - parameter orgId: The organization identifier.
- - parameter appId: The application identifier.
- - parameter baseUrl: The base URL that all calls will be made with.
-
- - returns: A new instance of `UsergridClientConfig`.
- */
- public convenience init(orgId: String, appId: String, baseUrl:String) {
- self.init(orgId:orgId,appId:appId)
- self.baseUrl = baseUrl
- }
-
- /**
- Convenience initializer for `UsergridClientConfig`.
-
- - parameter orgId: The organization identifier.
- - parameter appId: The application identifier.
- - parameter baseUrl: The base URL that all calls will be made with.
- - parameter authMode: The `UsergridAuthMode` value used to determine what type of token will be sent, if any.
- - parameter persistCurrentUserInKeychain: Whether or not the `UsergridClient` current user will be saved and restored from the keychain.
- - parameter appAuth: The application level `UsergridAppAuth` object.
-
- - returns: A new instance of `UsergridClientConfig`.
- */
- public convenience init(orgId: String, appId: String, baseUrl:String, authMode:UsergridAuthMode, persistCurrentUserInKeychain: Bool = true, appAuth:UsergridAppAuth? = nil) {
- self.init(orgId:orgId,appId:appId,baseUrl:baseUrl)
- self.persistCurrentUserInKeychain = persistCurrentUserInKeychain
- self.authMode = authMode
- self.appAuth = appAuth
- }
-
- // MARK: - NSCoding -
-
- /**
- NSCoding protocol initializer.
-
- - parameter aDecoder: The decoder.
-
- - returns: A decoded `UsergridUser` object.
- */
- public required init?(coder aDecoder: NSCoder) {
- guard let appId = aDecoder.decodeObjectForKey("appId") as? String,
- let orgId = aDecoder.decodeObjectForKey("orgId") as? String,
- let baseUrl = aDecoder.decodeObjectForKey("baseUrl") as? String
- else {
- self.appId = ""
- self.orgId = ""
- super.init()
- return nil
- }
- self.appId = appId
- self.orgId = orgId
- self.baseUrl = baseUrl
- self.appAuth = aDecoder.decodeObjectForKey("appAuth") as? UsergridAppAuth
- self.persistCurrentUserInKeychain = aDecoder.decodeBoolForKey("persistCurrentUserInKeychain") ?? true
- self.authMode = UsergridAuthMode(rawValue:aDecoder.decodeIntegerForKey("authMode")) ?? .None
- super.init()
- }
-
- /**
- NSCoding protocol encoder.
-
- - parameter aCoder: The encoder.
- */
- public func encodeWithCoder(aCoder: NSCoder) {
- aCoder.encodeObject(self.appId, forKey: "appId")
- aCoder.encodeObject(self.orgId, forKey: "orgId")
- aCoder.encodeObject(self.baseUrl, forKey: "baseUrl")
- aCoder.encodeObject(self.appAuth, forKey: "appAuth")
- aCoder.encodeBool(self.persistCurrentUserInKeychain, forKey: "persistCurrentUserInKeychain")
- aCoder.encodeInteger(self.authMode.rawValue, forKey: "authMode")
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridDevice.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridDevice.swift b/sdks/swift/Source/UsergridDevice.swift
deleted file mode 100644
index 004c42c..0000000
--- a/sdks/swift/Source/UsergridDevice.swift
+++ /dev/null
@@ -1,213 +0,0 @@
-//
-// UsergridDevice.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 10/23/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-#if !os(OSX)
-import UIKit
-#endif
-
-#if os(watchOS)
-import WatchKit
-#endif
-
-/**
-`UsergridDevice` is an `UsergridEntity` subclass that encapsulates information about the current device as well as stores information about push tokens and Usergrid notifiers.
-
-To apply push tokens for Usergrid notifiers use the `UsergridClient.applyPushToken` method.
-*/
-public class UsergridDevice : UsergridEntity {
-
- /// The `UsergridDevice` type.
- static let DEVICE_ENTITY_TYPE = "device"
-
- // MARK: - Instance Properties -
-
- /// Property helper method for the `UsergridDevice` objects device model.
- public var model: String { return super[UsergridDeviceProperties.Model.stringValue] as! String }
-
- /// Property helper method for the `UsergridDevice` objects device platform.
- public var platform: String { return super[UsergridDeviceProperties.Platform.stringValue] as! String }
-
- /// Property helper method for the `UsergridDevice` objects device operating system version.
- public var osVersion: String { return super[UsergridDeviceProperties.OSVersion.stringValue] as! String }
-
- /// The shared instance of `UsergridDevice`.
- public static var sharedDevice: UsergridDevice = UsergridDevice.getOrCreateSharedDeviceFromKeychain()
-
- // MARK: - Initialization -
-
- /**
- Designated Initializer for `UsergridDevice` objects
-
- Most likely you will never need to create seperate instances of `UsergridDevice`. Use of `UsergridDevice.sharedInstance` is recommended.
-
- - returns: A new instance of `UsergridDevice`.
- */
- public init() {
- super.init(type: UsergridDevice.DEVICE_ENTITY_TYPE, propertyDict: UsergridDevice.commonDevicePropertyDict())
- }
-
- /**
- The required public initializer for `UsergridEntity` subclasses.
-
- - parameter type: The type associated with the `UsergridEntity` object.
- - parameter name: The optional name associated with the `UsergridEntity` object.
- - parameter propertyDict: The optional property dictionary that the `UsergridEntity` object will start out with.
-
- - returns: A new `UsergridDevice` object.
- */
- required public init(type:String, name:String? = nil, propertyDict:[String:AnyObject]? = nil) {
- super.init(type: type, name: name, propertyDict: propertyDict)
- }
-
- // MARK: - NSCoding -
-
- /**
- NSCoding protocol initializer.
-
- - parameter aDecoder: The decoder.
-
- - returns: A decoded `UsergridUser` object.
- */
- required public init?(coder aDecoder: NSCoder) {
- super.init(coder: aDecoder)
- }
-
- /**
- NSCoding protocol encoder.
-
- - parameter aCoder: The encoder.
- */
- public override func encodeWithCoder(aCoder: NSCoder) {
- super.encodeWithCoder(aCoder)
- }
-
- /**
- Performs a PUT (or POST if no UUID is found) on the `UsergridDevice` using the shared instance of `UsergridClient`.
-
- If this device is equal to `UsergridDevice.sharedDevice` it will also update the shared device on the keychain.
-
- - parameter completion: An optional completion block that, if successful, will contain the updated/saved `UsergridEntity` object.
- */
- public override func save(completion: UsergridResponseCompletion? = nil) {
- self.save(Usergrid.sharedInstance, completion: completion)
- }
-
-
- /**
- Performs a PUT (or POST if no UUID is found) on the `UsergridDevice`.
-
- If this device is equal to `UsergridDevice.sharedDevice` it will also update the shared device on the keychain.
-
- - parameter client: The client to use when saving.
- - parameter completion: An optional completion block that, if successful, will contain the updated/saved `UsergridEntity` object.
- */
- public override func save(client: UsergridClient, completion: UsergridResponseCompletion? = nil) {
- super.save(client) { (response) in
- if( response.ok ) {
- if( self == UsergridDevice.sharedDevice || self.isEqualToEntity(UsergridDevice.sharedDevice)) {
- UsergridDevice.saveSharedDeviceToKeychain()
- }
- }
- completion?(response:response)
- }
- }
-
- /**
- Saves the `UsergridDevice.sharedDevice` to the keychain.
- */
- public static func saveSharedDeviceToKeychain() {
- UsergridDevice.saveSharedDeviceKeychainItem(UsergridDevice.sharedDevice)
- }
-
- /**
- Subscript for the `UsergridDevice` class. Note that all of the `UsergridDeviceProperties` are immutable.
-
- - Warning: When setting a properties value must be a valid JSON object.
-
- - Example usage:
- ```
- let uuid = usergridDevice["uuid"]
- ```
- */
- override public subscript(propertyName: String) -> AnyObject? {
- get {
- return super[propertyName]
- }
- set(propertyValue) {
- if UsergridDeviceProperties.fromString(propertyName) == nil {
- super[propertyName] = propertyValue
- }
- }
- }
-
- // MARK: - Class Helper Methods -
-
- /**
- Creates a property dictionary that contains the common properties for `UsergridDevice` objects.
-
- - returns: A property dictionary with the common properties set.
- */
- public static func commonDevicePropertyDict() -> [String:AnyObject] {
- var commonDevicePropertyDict: [String:AnyObject] = [:]
- commonDevicePropertyDict[UsergridEntityProperties.EntityType.stringValue] = UsergridDevice.DEVICE_ENTITY_TYPE
-
- #if os(watchOS)
- commonDevicePropertyDict[UsergridDeviceProperties.Model.stringValue] = WKInterfaceDevice.currentDevice().model
- commonDevicePropertyDict[UsergridDeviceProperties.Platform.stringValue] = WKInterfaceDevice.currentDevice().systemName
- commonDevicePropertyDict[UsergridDeviceProperties.OSVersion.stringValue] = WKInterfaceDevice.currentDevice().systemVersion
- #elseif os(iOS) || os(tvOS)
- commonDevicePropertyDict[UsergridDeviceProperties.Model.stringValue] = UIDevice.currentDevice().model
- commonDevicePropertyDict[UsergridDeviceProperties.Platform.stringValue] = UIDevice.currentDevice().systemName
- commonDevicePropertyDict[UsergridDeviceProperties.OSVersion.stringValue] = UIDevice.currentDevice().systemVersion
- #elseif os(OSX)
- commonDevicePropertyDict[UsergridDeviceProperties.Model.stringValue] = "Mac"
- commonDevicePropertyDict[UsergridDeviceProperties.Platform.stringValue] = "OSX"
- commonDevicePropertyDict[UsergridDeviceProperties.OSVersion.stringValue] = NSProcessInfo.processInfo().operatingSystemVersionString
- #endif
-
- return commonDevicePropertyDict
- }
-
- // MARK: - Push Token Handling -
-
- /**
- Sets the push token for the given notifier ID.
-
- This does not perform any API requests to update on Usergrid, rather it will just set the information in the `UsergridDevice` instance.
-
- In order to set the push token and perform an API request, use `UsergridClient.applyPushToken`.
-
- - parameter pushToken: The push token from Apple.
- - parameter notifierID: The notifier ID.
- */
- internal func applyPushToken(pushToken: NSData, notifierID: String) {
- self[notifierID + USERGRID_NOTIFIER_ID_SUFFIX] = pushToken.description.stringByTrimmingCharactersInSet(NSCharacterSet(charactersInString: "<>")).stringByReplacingOccurrencesOfString(" ", withString: "")
- }
-}
-
-private let USERGRID_NOTIFIER_ID_SUFFIX = ".notifier.id"
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridEntity.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridEntity.swift b/sdks/swift/Source/UsergridEntity.swift
deleted file mode 100644
index dd169ed..0000000
--- a/sdks/swift/Source/UsergridEntity.swift
+++ /dev/null
@@ -1,635 +0,0 @@
-//
-// UsergridEntity.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 7/21/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import CoreLocation
-
-/**
-`UsergridEntity` is the base class that contains a single Usergrid entity.
-
-`UsergridEntity` maintains a set of accessor properties for standard Usergrid schema properties (e.g. name, uuid), and supports helper methods for accessing any custom properties that might exist.
-*/
-public class UsergridEntity: NSObject, NSCoding {
-
- static private var subclassMappings: [String:UsergridEntity.Type] = [UsergridUser.USER_ENTITY_TYPE:UsergridUser.self,UsergridDevice.DEVICE_ENTITY_TYPE:UsergridDevice.self]
-
- // MARK: - Instance Properties -
-
- /// The property dictionary that stores the properties values of the `UsergridEntity` object.
- private var properties: [String : AnyObject] {
- didSet {
- if let fileMetaData = properties.removeValueForKey(UsergridFileMetaData.FILE_METADATA) as? [String:AnyObject] {
- self.fileMetaData = UsergridFileMetaData(fileMetaDataJSON: fileMetaData)
- } else {
- self.fileMetaData = nil
- }
- }
- }
-
- /// The `UsergridAsset` that contains the asset data.
- internal(set) public var asset: UsergridAsset?
-
- /// The `UsergridFileMetaData` of this `UsergridEntity`.
- internal(set) public var fileMetaData : UsergridFileMetaData?
-
- /// Property helper method for the `UsergridEntity` objects `UsergridEntityProperties.EntityType`.
- public var type: String { return self.getEntitySpecificProperty(.EntityType) as! String }
-
- /// Property helper method for the `UsergridEntity` objects `UsergridEntityProperties.UUID`.
- public var uuid: String? { return self.getEntitySpecificProperty(.UUID) as? String }
-
- /// Property helper method for the `UsergridEntity` objects `UsergridEntityProperties.Name`.
- public var name: String? { return self.getEntitySpecificProperty(.Name) as? String }
-
- /// Property helper method for the `UsergridEntity` objects `UsergridEntityProperties.Created`.
- public var created: NSDate? { return self.getEntitySpecificProperty(.Created) as? NSDate }
-
- /// Property helper method for the `UsergridEntity` objects `UsergridEntityProperties.Modified`.
- public var modified: NSDate? { return self.getEntitySpecificProperty(.Modified) as? NSDate }
-
- /// Property helper method for the `UsergridEntity` objects `UsergridEntityProperties.Location`.
- public var location: CLLocation? {
- get { return self.getEntitySpecificProperty(.Location) as? CLLocation }
- set(newLocation) { self[UsergridEntityProperties.Location.stringValue] = newLocation }
- }
-
- /// Property helper method to get the UUID or name of the `UsergridEntity`.
- public var uuidOrName: String? { return self.uuid ?? self.name }
-
- /// Tells you if this `UsergridEntity` has a type of `user`.
- public var isUser: Bool { return self is UsergridUser || self.type == UsergridUser.USER_ENTITY_TYPE }
-
- /// Tells you if there is an asset associated with this entity.
- public var hasAsset: Bool { return self.asset != nil || self.fileMetaData?.contentLength > 0 }
-
- /// The JSON object value.
- public var jsonObjectValue : [String:AnyObject] { return self.properties }
-
- /// The string value.
- public var stringValue : String { return NSString(data: try! NSJSONSerialization.dataWithJSONObject(self.jsonObjectValue, options: .PrettyPrinted), encoding: NSUTF8StringEncoding) as! String }
-
- /// The description.
- public override var description : String {
- return "Properties of Entity: \(stringValue)."
- }
-
- /// The debug description.
- public override var debugDescription : String {
- return "Properties of Entity: \(stringValue)."
- }
-
- // MARK: - Initialization -
-
- /**
- Designated initializer for `UsergridEntity` objects
-
- - parameter type: The type associated with the `UsergridEntity` object.
- - parameter name: The optional name associated with the `UsergridEntity` object.
- - parameter propertyDict: The optional property dictionary that the `UsergridEntity` object will start out with.
-
- - returns: A new `UsergridEntity` object.
- */
- required public init(type:String, name:String? = nil, propertyDict:[String:AnyObject]? = nil) {
- self.properties = propertyDict ?? [:]
- super.init()
-
- if self is UsergridUser {
- self.properties[UsergridEntityProperties.EntityType.stringValue] = UsergridUser.USER_ENTITY_TYPE
- } else if self is UsergridDevice {
- self.properties[UsergridEntityProperties.EntityType.stringValue] = UsergridDevice.DEVICE_ENTITY_TYPE
- } else {
- self.properties[UsergridEntityProperties.EntityType.stringValue] = type
- }
-
- if let entityName = name {
- self.properties[UsergridEntityProperties.Name.stringValue] = entityName
- }
-
- if let fileMetaData = self.properties.removeValueForKey(UsergridFileMetaData.FILE_METADATA) as? [String:AnyObject] {
- self.fileMetaData = UsergridFileMetaData(fileMetaDataJSON: fileMetaData)
- }
- }
-
- internal func copyInternalsFromEntity(entity:UsergridEntity) {
- self.properties = entity.properties
- }
-
- /**
- Used for custom mapping subclasses to a given `Usergrid` type.
-
- - parameter type: The type of the `Usergrid` object.
- - parameter toSubclass: The subclass `UsergridEntity.Type` to map it to.
- */
- public static func mapCustomType(type:String,toSubclass:UsergridEntity.Type) {
- UsergridEntity.subclassMappings[type] = toSubclass
- }
-
- /**
- Class convenience constructor for creating `UsergridEntity` objects dynamically.
-
- - parameter jsonDict: A valid JSON dictionary which must contain at the very least a value for the `type` key.
-
- - returns: A `UsergridEntity` object provided that the `type` key within the dictionay exists. Otherwise nil.
- */
- public class func entity(jsonDict jsonDict: [String:AnyObject]) -> UsergridEntity? {
- guard let type = jsonDict[UsergridEntityProperties.EntityType.stringValue] as? String
- else {
- return nil
- }
-
- let mapping = UsergridEntity.subclassMappings[type] ?? UsergridEntity.self
- return mapping.init(type: type, propertyDict: jsonDict)
- }
-
- /**
- Class convenience constructor for creating multiple `UsergridEntity` objects dynamically.
-
- - parameter entitiesJSONArray: An array which contains dictionaries that are used to create the `UsergridEntity` objects.
-
- - returns: An array of `UsergridEntity`.
- */
- public class func entities(jsonArray entitiesJSONArray: [[String:AnyObject]]) -> [UsergridEntity] {
- var entityArray : [UsergridEntity] = []
- for entityJSONDict in entitiesJSONArray {
- if let entity = UsergridEntity.entity(jsonDict:entityJSONDict) {
- entityArray.append(entity)
- }
- }
- return entityArray
- }
-
- // MARK: - NSCoding -
-
- /**
- NSCoding protocol initializer.
-
- - parameter aDecoder: The decoder.
-
- - returns: A decoded `UsergridUser` object.
- */
- required public init?(coder aDecoder: NSCoder) {
- guard let properties = aDecoder.decodeObjectForKey("properties") as? [String:AnyObject]
- else {
- self.properties = [:]
- super.init()
- return nil
- }
- self.properties = properties
- self.fileMetaData = aDecoder.decodeObjectForKey("fileMetaData") as? UsergridFileMetaData
- self.asset = aDecoder.decodeObjectForKey("asset") as? UsergridAsset
- super.init()
- }
-
- /**
- NSCoding protocol encoder.
-
- - parameter aCoder: The encoder.
- */
- public func encodeWithCoder(aCoder: NSCoder) {
- aCoder.encodeObject(self.properties, forKey: "properties")
- aCoder.encodeObject(self.fileMetaData, forKey: "fileMetaData")
- aCoder.encodeObject(self.asset, forKey: "asset")
- }
-
- // MARK: - Property Manipulation -
-
- /**
- Subscript for the `UsergridEntity` class.
-
- - Example usage:
- ```
- let propertyValue = usergridEntity["propertyName"]
- usergridEntity["propertyName"] = propertyValue
- ```
- */
- public subscript(propertyName: String) -> AnyObject? {
- get {
- if let entityProperty = UsergridEntityProperties.fromString(propertyName) {
- return self.getEntitySpecificProperty(entityProperty)
- } else {
- let propertyValue = self.properties[propertyName]
- if propertyValue === NSNull() { // Let's just return nil for properties that have been removed instead of NSNull
- return nil
- } else {
- return propertyValue
- }
- }
- }
- set(propertyValue) {
- if let value = propertyValue {
- if let entityProperty = UsergridEntityProperties.fromString(propertyName) {
- if entityProperty.isMutableForEntity(self) {
- if entityProperty == .Location {
- if let location = value as? CLLocation {
- properties[propertyName] = [ENTITY_LATITUDE:location.coordinate.latitude,
- ENTITY_LONGITUDE:location.coordinate.longitude]
- } else if let location = value as? CLLocationCoordinate2D {
- properties[propertyName] = [ENTITY_LATITUDE:location.latitude,
- ENTITY_LONGITUDE:location.longitude]
- } else if let location = value as? [String:Double] {
- if let lat = location[ENTITY_LATITUDE], long = location[ENTITY_LONGITUDE] {
- properties[propertyName] = [ENTITY_LATITUDE:lat,
- ENTITY_LONGITUDE:long]
- }
- }
- } else {
- properties[propertyName] = value
- }
- }
- } else {
- properties[propertyName] = value
- }
- } else { // If the property value is nil we assume they wanted to remove the property.
-
- // We set the value for this property to Null so that when a PUT is performed on the entity the property will actually be removed from the Entity on Usergrid
- if let entityProperty = UsergridEntityProperties.fromString(propertyName){
- if entityProperty.isMutableForEntity(self) {
- properties[propertyName] = NSNull()
- }
- } else {
- properties[propertyName] = NSNull()
- }
- }
- }
- }
-
- /**
- Updates a properties value for the given property name.
-
- - parameter name: The name of the property.
- - parameter value: The value to update to.
- */
- public func putProperty(name:String,value:AnyObject?) {
- self[name] = value
- }
-
- /**
- Updates a set of properties that are within the given properties dictionary.
-
- - parameter properties: The property dictionary containing the properties names and values.
- */
- public func putProperties(properties:[String:AnyObject]) {
- for (name,value) in properties {
- self.putProperty(name, value: value)
- }
- }
-
- /**
- Removes the property for the given property name.
-
- - parameter name: The name of the property.
- */
- public func removeProperty(name:String) {
- self[name] = nil
- }
-
- /**
- Removes the properties with the names within the propertyNames array
-
- - parameter propertyNames: An array of property names.
- */
- public func removeProperties(propertyNames:[String]) {
- for name in propertyNames {
- self.removeProperty(name)
- }
- }
-
- /**
- Appends the given value to the end of the properties current value.
-
- - parameter name: The name of the property.
- - parameter value: The value or an array of values to append.
- */
- public func append(name:String, value:AnyObject) {
- self.insertArray(name, values:value as? [AnyObject] ?? [value], index: Int.max)
- }
-
- /**
- Inserts the given value at the given index within the properties current value.
-
- - parameter name: The name of the property.
- - parameter index: The index to insert at.
- - parameter value: The value or an array of values to insert.
- */
- public func insert(name:String, value:AnyObject, index:Int = 0) {
- self.insertArray(name, values:value as? [AnyObject] ?? [value], index: index)
- }
-
- /**
- Inserts an array of property values at a given index within the properties current value.
-
- - parameter name: The name of the property
- - parameter index: The index to insert at.
- - parameter values: The values to insert.
- */
- private func insertArray(name:String,values:[AnyObject], index:Int = 0) {
- if let propertyValue = self[name] {
- if let arrayValue = propertyValue as? [AnyObject] {
- var arrayOfValues = arrayValue
- if index > arrayValue.count {
- arrayOfValues.appendContentsOf(values)
- } else {
- arrayOfValues.insertContentsOf(values, at: index)
- }
- self[name] = arrayOfValues
- } else {
- if index > 0 {
- self[name] = [propertyValue] + values
- } else {
- self[name] = values + [propertyValue]
- }
- }
- } else {
- self[name] = values
- }
- }
-
- /**
- Removes the last value of the properties current value.
-
- - parameter name: The name of the property.
- */
- public func pop(name:String) {
- if let arrayValue = self[name] as? [AnyObject] where arrayValue.count > 0 {
- var arrayOfValues = arrayValue
- arrayOfValues.removeLast()
- self[name] = arrayOfValues
- }
- }
-
- /**
- Removes the first value of the properties current value.
-
- - parameter name: The name of the property.
- */
- public func shift(name:String) {
- if let arrayValue = self[name] as? [AnyObject] where arrayValue.count > 0 {
- var arrayOfValues = arrayValue
- arrayOfValues.removeFirst()
- self[name] = arrayOfValues
- }
- }
-
- private func getEntitySpecificProperty(entityProperty: UsergridEntityProperties) -> AnyObject? {
- var propertyValue: AnyObject? = nil
- switch entityProperty {
- case .UUID,.EntityType,.Name :
- propertyValue = self.properties[entityProperty.stringValue]
- case .Created,.Modified :
- if let milliseconds = self.properties[entityProperty.stringValue] as? Int {
- propertyValue = NSDate(milliseconds: milliseconds.description)
- }
- case .Location :
- if let locationDict = self.properties[entityProperty.stringValue] as? [String:Double], lat = locationDict[ENTITY_LATITUDE], long = locationDict[ENTITY_LONGITUDE] {
- propertyValue = CLLocation(latitude: lat, longitude: long)
- }
- }
- return propertyValue
- }
-
- // MARK: - CRUD Convenience Methods -
-
- /**
- Performs a GET on the `UsergridEntity` using the shared instance of `UsergridClient`.
-
- - parameter completion: An optional completion block that, if successful, will contain the reloaded `UsergridEntity` object.
- */
- public func reload(completion: UsergridResponseCompletion? = nil) {
- self.reload(Usergrid.sharedInstance, completion: completion)
- }
-
- /**
- Performs a GET on the `UsergridEntity`.
-
- - parameter client: The client to use when reloading.
- - parameter completion: An optional completion block that, if successful, will contain the reloaded `UsergridEntity` object.
- */
- public func reload(client:UsergridClient, completion: UsergridResponseCompletion? = nil) {
- guard let uuidOrName = self.uuidOrName
- else {
- completion?(response: UsergridResponse(client: client, errorName: "Entity cannot be reloaded.", errorDescription: "Entity has neither an UUID or name specified."))
- return
- }
-
- client.GET(self.type, uuidOrName: uuidOrName) { response in
- if let responseEntity = response.entity {
- self.copyInternalsFromEntity(responseEntity)
- }
- completion?(response: response)
- }
- }
-
- /**
- Performs a PUT (or POST if no UUID is found) on the `UsergridEntity` using the shared instance of `UsergridClient`.
-
- - parameter completion: An optional completion block that, if successful, will contain the updated/saved `UsergridEntity` object.
- */
- public func save(completion: UsergridResponseCompletion? = nil) {
- self.save(Usergrid.sharedInstance, completion: completion)
- }
-
- /**
- Performs a PUT (or POST if no UUID is found) on the `UsergridEntity`.
-
- - parameter client: The client to use when saving.
- - parameter completion: An optional completion block that, if successful, will contain the updated/saved `UsergridEntity` object.
- */
- public func save(client:UsergridClient, completion: UsergridResponseCompletion? = nil) {
- if let _ = self.uuid { // If UUID exists we PUT otherwise POST
- client.PUT(self) { response in
- if let responseEntity = response.entity {
- self.copyInternalsFromEntity(responseEntity)
- }
- completion?(response: response)
- }
- } else {
- client.POST(self) { response in
- if let responseEntity = response.entity {
- self.copyInternalsFromEntity(responseEntity)
- }
- completion?(response: response)
- }
- }
- }
-
- /**
- Performs a DELETE on the `UsergridEntity` using the shared instance of the `UsergridClient`.
-
- - parameter completion: An optional completion block.
- */
- public func remove(completion: UsergridResponseCompletion? = nil) {
- self.remove(Usergrid.sharedInstance, completion: completion)
- }
-
- /**
- Performs a DELETE on the `UsergridEntity`.
-
- - parameter client: The client to use when removing.
- - parameter completion: An optional completion block.
- */
- public func remove(client:UsergridClient, completion: UsergridResponseCompletion? = nil) {
- client.DELETE(self, completion: completion)
- }
-
- // MARK: - Asset Management -
-
- /**
- Uploads the given `UsergridAsset` and the data within it and creates an association between this `UsergridEntity` with the given `UsergridAsset` using the shared instance of `UsergridClient`.
-
- - parameter asset: The `UsergridAsset` object to upload.
- - parameter progress: An optional progress block to keep track of upload progress.
- - parameter completion: An optional completion block.
- */
- public func uploadAsset(asset:UsergridAsset, progress:UsergridAssetRequestProgress? = nil, completion:UsergridAssetUploadCompletion? = nil) {
- self.uploadAsset(Usergrid.sharedInstance, asset: asset, progress: progress, completion: completion)
- }
-
- /**
- Uploads the given `UsergridAsset` and the data within it and creates an association between this `UsergridEntity` with the given `UsergridAsset`.
-
- - parameter client: The client to use when uploading.
- - parameter asset: The `UsergridAsset` object to upload.
- - parameter progress: An optional progress block to keep track of upload progress.
- - parameter completion: An optional completion block.
- */
- public func uploadAsset(client:UsergridClient, asset:UsergridAsset, progress:UsergridAssetRequestProgress? = nil, completion:UsergridAssetUploadCompletion? = nil) {
- client.uploadAsset(self, asset: asset, progress:progress, completion:completion)
- }
-
- /**
- Downloads the `UsergridAsset` that is associated with this `UsergridEntity` using the shared instance of `UsergridClient`.
-
- - parameter contentType: The content type of the data to load.
- - parameter progress: An optional progress block to keep track of download progress.
- - parameter completion: An optional completion block.
- */
- public func downloadAsset(contentType:String, progress:UsergridAssetRequestProgress? = nil, completion:UsergridAssetDownloadCompletion? = nil) {
- self.downloadAsset(Usergrid.sharedInstance, contentType: contentType, progress: progress, completion: completion)
- }
-
- /**
- Downloads the `UsergridAsset` that is associated with this `UsergridEntity`.
-
- - parameter client: The client to use when uploading.
- - parameter contentType: The content type of the data to load.
- - parameter progress: An optional progress block to keep track of download progress.
- - parameter completion: An optional completion block.
- */
- public func downloadAsset(client:UsergridClient, contentType:String, progress:UsergridAssetRequestProgress? = nil, completion:UsergridAssetDownloadCompletion? = nil) {
- client.downloadAsset(self, contentType: contentType, progress:progress, completion: completion)
- }
-
- // MARK: - Connection Management -
-
- /**
- Creates a relationship between this `UsergridEntity` and the given entity using the shared instance of `UsergridClient`.
-
- - parameter relationship: The relationship type.
- - parameter toEntity: The entity to connect.
- - parameter completion: An optional completion block.
- */
- public func connect(relationship:String, toEntity:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- self.connect(Usergrid.sharedInstance, relationship: relationship, toEntity: toEntity, completion: completion)
- }
-
- /**
- Creates a relationship between this `UsergridEntity` and the given entity.
-
- - parameter client: The client to use when connecting.
- - parameter relationship: The relationship type.
- - parameter toEntity: The entity to connect.
- - parameter completion: An optional completion block.
- */
- public func connect(client:UsergridClient, relationship:String, toEntity:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- client.connect(self, relationship: relationship, to: toEntity, completion: completion)
- }
-
- /**
- Removes a relationship between this `UsergridEntity` and the given entity using the shared instance of `UsergridClient`.
-
- - parameter relationship: The relationship type.
- - parameter fromEntity: The entity to disconnect.
- - parameter completion: An optional completion block.
- */
- public func disconnect(relationship:String, fromEntity:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- self.disconnect(Usergrid.sharedInstance, relationship: relationship, fromEntity: fromEntity, completion: completion)
- }
-
- /**
- Removes a relationship between this `UsergridEntity` and the given entity.
-
- - parameter client: The client to use when disconnecting.
- - parameter relationship: The relationship type.
- - parameter fromEntity: The entity to disconnect.
- - parameter completion: An optional completion block.
- */
- public func disconnect(client:UsergridClient, relationship:String, fromEntity:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- client.disconnect(self, relationship: relationship, from: fromEntity, completion: completion)
- }
-
- /**
- Gets the `UsergridEntity` objects, if any, which are connected via the relationship using the shared instance of `UsergridClient`.
-
- - parameter direction: The direction of the connection.
- - parameter relationship: The relationship type.
- - parameter query: The optional query.
- - parameter completion: An optional completion block.
- */
- public func getConnections(direction:UsergridDirection, relationship:String, query:UsergridQuery? = nil, completion:UsergridResponseCompletion? = nil) {
- self.getConnections(Usergrid.sharedInstance, direction: direction, relationship: relationship, query: query, completion: completion)
- }
-
- /**
- Gets the `UsergridEntity` objects, if any, which are connected via the relationship.
-
- - parameter client: The client to use when getting the connected `UsergridEntity` objects.
- - parameter direction: The direction of the connection.
- - parameter relationship: The relationship type.
- - parameter query: The optional query.
- - parameter completion: An optional completion block.
- */
- public func getConnections(client:UsergridClient, direction:UsergridDirection, relationship:String, query:UsergridQuery? = nil, completion:UsergridResponseCompletion? = nil) {
- client.getConnections(direction, entity: self, relationship: relationship, query:query, completion: completion)
- }
-
- // MARK: - Helper methods -
-
- /**
- Determines if the two `UsergridEntity` objects are equal. i.e. they have the same non nil uuidOrName.
-
- - parameter entity: The entity to check.
-
- - returns: If the two `UsergridEntity` objects are equal. i.e. they have the same non nil uuidOrName.
- */
- public func isEqualToEntity(entity: UsergridEntity?) -> Bool {
- guard let selfUUID = self.uuidOrName,
- let entityUUID = entity?.uuidOrName
- else {
- return false
- }
- return selfUUID == entityUUID
- }
-}
\ No newline at end of file
[32/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridUser.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridUser.html b/sdks/swift/docs/Classes/UsergridUser.html
deleted file mode 100644
index aa93547..0000000
--- a/sdks/swift/docs/Classes/UsergridUser.html
+++ /dev/null
@@ -1,2434 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridUser 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/UsergridUser" class="dashAnchor"></a>
- <a title="UsergridUser 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" />
- UsergridUser 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>UsergridUser</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridUser</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridUser</code> is a special subclass of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> that supports functions and properties unique to users.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:iC11UsergridSDK12UsergridUser9subscriptFSSGSqPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:iC11UsergridSDK12UsergridUser9subscriptFSSGSqPs9AnyObject__">subscript(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Subscript for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> class.</p>
-
-<div class="aside aside-warning">
- <p class="aside-title">Warning</p>
- <p>When setting a properties value must be a valid JSON object.</p>
-
-</div>
-
-<p><li><p>Example usage:
-“`
-let someName = usergridUser[<q>name</q>]</p></li></p>
-
-<p>usergridUser[<q>name</q>] = someName
-”`</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="nf">subscript</span><span class="p">(</span><span class="nv">propertyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AnyObject</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="/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:vC11UsergridSDK12UsergridUser4authGSqCS_16UsergridUserAuth_"></a>
- <a name="//apple_ref/swift/Property/auth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser4authGSqCS_16UsergridUserAuth_">auth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> object if this user was authenticated.</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">auth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridUser4nameGSqSS_"></a>
- <a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser4nameGSqSS_">name</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties4NameFMS0_S0_">UsergridUserProperties.Name</a></code>.</p>
-
-<p>Unlike <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects, <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s can change their name property which is why we provide a getter here.</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="k">var</span> <span class="nv">name</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:vC11UsergridSDK12UsergridUser8usernameGSqSS_"></a>
- <a name="//apple_ref/swift/Property/username" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser8usernameGSqSS_">username</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties8UsernameFMS0_S0_">UsergridUserProperties.Username</a></code>.</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">username</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:vC11UsergridSDK12UsergridUser8passwordGSqSS_"></a>
- <a name="//apple_ref/swift/Property/password" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser8passwordGSqSS_">password</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties8PasswordFMS0_S0_">UsergridUserProperties.Password</a></code>.</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">password</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:vC11UsergridSDK12UsergridUser5emailGSqSS_"></a>
- <a name="//apple_ref/swift/Property/email" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser5emailGSqSS_">email</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties5EmailFMS0_S0_">UsergridUserProperties.Email</a></code>.</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">email</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:vC11UsergridSDK12UsergridUser3ageGSqCSo8NSNumber_"></a>
- <a name="//apple_ref/swift/Property/age" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser3ageGSqCSo8NSNumber_">age</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties3AgeFMS0_S0_">UsergridUserProperties.Age</a></code>.</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">age</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridUser15usernameOrEmailGSqSS_"></a>
- <a name="//apple_ref/swift/Property/usernameOrEmail" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser15usernameOrEmailGSqSS_">usernameOrEmail</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method to get the username or email of the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</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">usernameOrEmail</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">username</span> <span class="p">??</span> <span class="k">self</span><span class="o">.</span><span class="n">email</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridUser9activatedSb"></a>
- <a name="//apple_ref/swift/Property/activated" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser9activatedSb">activated</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties9ActivatedFMS0_S0_">UsergridUserProperties.Activated</a></code>.</p>
-
-<p>Indicates whether the user account has been activated or not.</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">activated</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridUser8disabledSb"></a>
- <a name="//apple_ref/swift/Property/disabled" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser8disabledSb">disabled</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties8DisabledFMS0_S0_">UsergridUserProperties.Disabled</a></code>.</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">disabled</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridUser7pictureGSqSS_"></a>
- <a name="//apple_ref/swift/Property/picture" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser7pictureGSqSS_">picture</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties7PictureFMS0_S0_">UsergridUserProperties.Picture</a></code>.</p>
-
-<p>URL path to user\u2019s profile picture. Defaults to Gravatar for email address.</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">picture</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:vC11UsergridSDK12UsergridUser14uuidOrUsernameGSqSS_"></a>
- <a name="//apple_ref/swift/Property/uuidOrUsername" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridUser14uuidOrUsernameGSqSS_">uuidOrUsername</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The UUID or username property value if found.</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">uuidOrUsername</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">uuid</span> <span class="p">??</span> <span class="k">self</span><span class="o">.</span><span class="n">username</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:FC11UsergridSDK12UsergridUsercFT4nameGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(name:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameGSqSS__S0_">init(name:)</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/UsergridUser.html">UsergridUser</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">name</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>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the user. Note this is different from the <code>username</code> property.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a>
- <a name="//apple_ref/swift/Method/init(type:name:propertyDict:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_">init(type:name:propertyDict:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The required public initializer for <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> subclasses.</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="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">propertyDict</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></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The type associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional name associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>propertyDict</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional property dictionary that the <code>UsergridEntity</code> object will start out with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameSS12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a>
- <a name="//apple_ref/swift/Method/init(name:propertyDict:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameSS12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_">init(name:propertyDict:)</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/UsergridUser.html">UsergridUser</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">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span><span class="nv">propertyDict</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></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the user. Note this is different from the <code>username</code> property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>propertyDict</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional property dictionary that the <code>UsergridEntity</code> object will start out with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameSS5emailSS8passwordGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(name:email:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameSS5emailSS8passwordGSqSS__S0_">init(name:email:password:)</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/UsergridUser.html">UsergridUser</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">email</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the user. Note this is different from the <code>username</code> property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>email</em>
- </code>
- </td>
- <td>
- <div>
- <p>The user’s email.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s password.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT5emailSS8passwordGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(email:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT5emailSS8passwordGSqSS__S0_">init(email:password:)</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/UsergridUser.html">UsergridUser</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">email</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>email</em>
- </code>
- </td>
- <td>
- <div>
- <p>The user’s email.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s password.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameSS8usernameSS8passwordGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(name:username:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameSS8usernameSS8passwordGSqSS__S0_">init(name:username:password:)</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/UsergridUser.html">UsergridUser</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the user. Note this is different from the <code>username</code> property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username of the user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s password.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT8usernameSS8passwordGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(username:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT8usernameSS8passwordGSqSS__S0_">init(username:password:)</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/UsergridUser.html">UsergridUser</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username of the user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s password.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameGSqSS_5emailGSqSS_8usernameGSqSS_8passwordGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(name:email:username:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameGSqSS_5emailGSqSS_8usernameGSqSS_8passwordGSqSS__S0_">init(name:email:username:password:)</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/UsergridUser.html">UsergridUser</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">email</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">password</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>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional name of the user. Note this is different from the <code>username</code> property.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>email</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s email.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional username of the user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional user’s password.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</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:FC11UsergridSDK12UsergridUsercFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT5coderCSo7NSCoder_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:FC11UsergridSDK12UsergridUser15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser15encodeWithCoderFCSo7NSCoderT_">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="k">override</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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Class%20Methods"></a>
- <a name="//apple_ref/swift/Section/Class Methods" class="dashAnchor"></a>
- <a href="#/Class%20Methods">
- <h3 class="section-name">Class Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_"></a>
- <a name="//apple_ref/swift/Method/checkAvailable(_:username:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_">checkAvailable(_:username:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Checks the given email and/or username availablity for new <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">checkAvailable</span><span class="p">(</span><span class="nv">email</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserAvailabilityCompletion</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>email</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional email address.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional username.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTCS_14UsergridClient5emailGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_"></a>
- <a name="//apple_ref/swift/Method/checkAvailable(_:email:username:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTCS_14UsergridClient5emailGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_">checkAvailable(_:email:username:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Checks the given email and/or username availablity for new <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects using with the given <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">checkAvailable</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">email</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserAvailabilityCompletion</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use for checking availability.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>email</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional email address.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional username.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Instance%20Methods"></a>
- <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
- <a href="#/Instance%20Methods">
- <h3 class="section-name">Instance Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUser6createFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/create(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser6createFTGSqFT8responseCS_16UsergridResponse_T___T_">create(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates the user object in Usergrid if the user does not already exist with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">create</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUser6createFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/create(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser6createFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">create(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates the user object in Usergrid if the user does not already exist with the given <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">create</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use for creation.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUser5loginFTSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/login(_:password:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser5loginFTSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__T___T_">login(_:password:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates the specified user using the provided username and password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
-<p>While functionally similar to <code>UsergridClient.authenticateUser(auth)</code>, this method does not automatically assign this user to <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>:</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">login</span><span class="p">(</span><span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUser5loginFTCS_14UsergridClient8usernameSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/login(_:username:password:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser5loginFTCS_14UsergridClient8usernameSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__T___T_">login(_:username:password:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates the specified user using the provided username and password.</p>
-
-<p>While functionally similar to <code>UsergridClient.authenticateUser(auth)</code>, this method does not automatically assign this user to <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>:</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">login</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use for login.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridUser13resetPasswordFTSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a>
- <a name="//apple_ref/swift/Method/resetPassword(_:new:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridUser13resetPasswordFTSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:new:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Changes the User’s current password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">resetPassword</span><span class="p">(</span><span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserResetPasswordCompletion</span><span class="p">?</span> <span class="o">=
<TRUNCATED>
[11/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridQueryOperator.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridQueryOperator.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridQueryOperator.html
deleted file mode 100644
index fc07091..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridQueryOperator.html
+++ /dev/null
@@ -1,431 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridQueryOperator Enum 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/Enum/UsergridQueryOperator" class="dashAnchor"></a>
- <a title="UsergridQueryOperator Enum 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" />
- UsergridQueryOperator Enum 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>UsergridQueryOperator</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridQueryOperator</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code><a href="../Classes/UsergridQuery.html">UsergridQuery</a></code> specific operators.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK21UsergridQueryOperator5EqualFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Equal" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK21UsergridQueryOperator5EqualFMS0_S0_">Equal</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>’=’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Equal</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK21UsergridQueryOperator11GreaterThanFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/GreaterThan" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK21UsergridQueryOperator11GreaterThanFMS0_S0_">GreaterThan</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>’>’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">GreaterThan</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK21UsergridQueryOperator18GreaterThanEqualToFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/GreaterThanEqualTo" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK21UsergridQueryOperator18GreaterThanEqualToFMS0_S0_">GreaterThanEqualTo</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>’>=’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">GreaterThanEqualTo</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK21UsergridQueryOperator8LessThanFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/LessThan" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK21UsergridQueryOperator8LessThanFMS0_S0_">LessThan</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>’<’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">LessThan</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK21UsergridQueryOperator15LessThanEqualToFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/LessThanEqualTo" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK21UsergridQueryOperator15LessThanEqualToFMS0_S0_">LessThanEqualTo</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>’<=’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">LessThanEqualTo</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFO11UsergridSDK21UsergridQueryOperator10fromStringFSSGSqS0__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFO11UsergridSDK21UsergridQueryOperator10fromStringFSSGSqS0__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets the corresponding <code><a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a></code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridQueryOperator</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stringValue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The string value to convert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The corresponding <code><a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a></code> or nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK21UsergridQueryOperator11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK21UsergridQueryOperator11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Enums/UsergridQuerySortOrder.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridQuerySortOrder.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridQuerySortOrder.html
deleted file mode 100644
index 3758d3f..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridQuerySortOrder.html
+++ /dev/null
@@ -1,338 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridQuerySortOrder Enum 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/Enum/UsergridQuerySortOrder" class="dashAnchor"></a>
- <a title="UsergridQuerySortOrder Enum 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" />
- UsergridQuerySortOrder Enum 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>UsergridQuerySortOrder</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridQuerySortOrder</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code><a href="../Classes/UsergridQuery.html">UsergridQuery</a></code> specific sort orders.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridQuerySortOrder3AscFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Asc" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridQuerySortOrder3AscFMS0_S0_">Asc</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort order is ascending.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Asc</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridQuerySortOrder4DescFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Desc" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridQuerySortOrder4DescFMS0_S0_">Desc</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort order is descending.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Desc</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFO11UsergridSDK22UsergridQuerySortOrder10fromStringFSSGSqS0__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFO11UsergridSDK22UsergridQuerySortOrder10fromStringFSSGSqS0__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets the corresponding <code><a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a></code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridQuerySortOrder</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stringValue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The string value to convert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The corresponding <code><a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a></code> or nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK22UsergridQuerySortOrder11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK22UsergridQuerySortOrder11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Enums/UsergridUserProperties.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridUserProperties.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridUserProperties.html
deleted file mode 100644
index eff2cdc..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridUserProperties.html
+++ /dev/null
@@ -1,524 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridUserProperties Enum 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/Enum/UsergridUserProperties" class="dashAnchor"></a>
- <a title="UsergridUserProperties Enum 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" />
- UsergridUserProperties Enum 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>UsergridUserProperties</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridUserProperties</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> specific properties keys.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties4NameFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Name" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties4NameFMS0_S0_">Name</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘name’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Name</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties8UsernameFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Username" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties8UsernameFMS0_S0_">Username</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘username’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Username</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties8PasswordFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Password" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties8PasswordFMS0_S0_">Password</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘password’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Password</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties5EmailFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Email" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties5EmailFMS0_S0_">Email</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘email’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Email</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties3AgeFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Age" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties3AgeFMS0_S0_">Age</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘age’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Age</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties9ActivatedFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Activated" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties9ActivatedFMS0_S0_">Activated</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘activated’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Activated</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties8DisabledFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Disabled" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties8DisabledFMS0_S0_">Disabled</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘disabled’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Disabled</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties7PictureFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Picture" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties7PictureFMS0_S0_">Picture</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘picture’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Picture</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFO11UsergridSDK22UsergridUserProperties10fromStringFSSGSqS0__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFO11UsergridSDK22UsergridUserProperties10fromStringFSSGSqS0__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets the corresponding <code><a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a></code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridUserProperties</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stringValue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The string value to convert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The corresponding <code><a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a></code> or nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK22UsergridUserProperties11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK22UsergridUserProperties11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Extensions.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html
deleted file mode 100644
index a5c3fb5..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html
+++ /dev/null
@@ -1,203 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Extensions 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 title="Extensions 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" />
- Extensions 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>Extensions</h1>
- <p>The following extensions are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/c:objc(cs)NSDate"></a>
- <a name="//apple_ref/swift/Extension/NSDate" class="dashAnchor"></a>
- <a class="token" href="#/c:objc(cs)NSDate">NSDate</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- <a href="Extensions/NSDate.html" class="slightly-smaller">See more</a>
- </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>
[42/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/Usergrid.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/Usergrid.html b/sdks/swift/docs/Classes/Usergrid.html
deleted file mode 100644
index 61bf26f..0000000
--- a/sdks/swift/docs/Classes/Usergrid.html
+++ /dev/null
@@ -1,3798 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Usergrid 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/Usergrid" class="dashAnchor"></a>
- <a title="Usergrid 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" />
- Usergrid 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>Usergrid</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Usergrid</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p>The <code>Usergrid</code> class acts as a static shared instance manager for the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> class.</p>
-
-<p>The methods and variables in this class are all static and therefore you will never need or want to initialize an instance of the <code>Usergrid</code> class.</p>
-
-<p>Use of this class depends on initialization of the shared instance of the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> object. Because of this, before using any of the static methods
-provided you will need to call one of the shared instance initialization methods. Failure to do so will result in failure from all methods.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Static%20Variables"></a>
- <a name="//apple_ref/swift/Section/Static Variables" class="dashAnchor"></a>
- <a href="#/Static%20Variables">
- <h3 class="section-name">Static Variables</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid13isInitializedSb"></a>
- <a name="//apple_ref/swift/Variable/isInitialized" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid13isInitializedSb">isInitialized</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Used to determine if the shared instance of the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> has been initialized.</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">static</span> <span class="k">var</span> <span class="nv">isInitialized</span> <span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">_sharedClient</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Variable/sharedInstance" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">sharedInstance</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, used by the <code><a href="../Classes/Usergrid.html">Usergrid</a></code> static methods and acts as the default <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>
-within the UsergridSDK library.</p>
-
-<div class="aside aside-warning">
- <p class="aside-title">Warning</p>
- You must call one of the <code>Usergrid.initSharedInstance</code> methods before this or any other <code><a href="../Classes/Usergrid.html">Usergrid</a></code> static methods are valid.
-
-</div>
-
- </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">static</span> <span class="k">var</span> <span class="nv">sharedInstance</span> <span class="p">:</span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid5appIdSS"></a>
- <a name="//apple_ref/swift/Variable/appId" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid5appIdSS">appId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application identifier the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">appId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">appId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid5orgIdSS"></a>
- <a name="//apple_ref/swift/Variable/orgId" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid5orgIdSS">orgId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The organization identifier of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">orgId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">orgId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid7baseUrlSS"></a>
- <a name="//apple_ref/swift/Variable/baseUrl" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid7baseUrlSS">baseUrl</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The base URL that all calls will be made with of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">baseUrl</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">baseUrl</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid12clientAppURLSS"></a>
- <a name="//apple_ref/swift/Variable/clientAppURL" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid12clientAppURLSS">clientAppURL</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The constructed URL string based on the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s baseUrl, orgId, and appId of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">clientAppURL</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">clientAppURL</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_"></a>
- <a name="//apple_ref/swift/Variable/currentUser" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_">currentUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The currently logged in <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">currentUser</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">currentUser</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid28persistCurrentUserInKeychainSb"></a>
- <a name="//apple_ref/swift/Variable/persistCurrentUserInKeychain" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Whether or not the current user will be saved and restored from the keychain using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid8userAuthGSqCS_16UsergridUserAuth_"></a>
- <a name="//apple_ref/swift/Variable/userAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid8userAuthGSqCS_16UsergridUserAuth_">userAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> which consists of the token information from the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_">currentUser</a></code> property of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">userAuth</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid7appAuthGSqCS_15UsergridAppAuth_"></a>
- <a name="//apple_ref/swift/Variable/appAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid7appAuthGSqCS_15UsergridAppAuth_">appAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application level <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid8authModeOS_16UsergridAuthMode"></a>
- <a name="//apple_ref/swift/Variable/authMode" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid8authModeOS_16UsergridAuthMode">authMode</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, if any.</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">static</span> <span class="k">var</span> <span class="nv">authMode</span><span class="p">:</span> <span class="kt">UsergridAuthMode</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:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS_CS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/initSharedInstance(orgId:appId:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS_CS_14UsergridClient">initSharedInstance(orgId:appId:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">orgId</span> <span class="nv">orgId</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS7baseUrlSS_CS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/initSharedInstance(orgId:appId:baseUrl:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS7baseUrlSS_CS_14UsergridClient">initSharedInstance(orgId:appId:baseUrl:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">orgId</span> <span class="nv">orgId</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</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="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>baseUrl</em>
- </code>
- </td>
- <td>
- <div>
- <p>The base URL that all calls will be made with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT13configurationCS_20UsergridClientConfig_CS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/initSharedInstance(configuration:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT13configurationCS_20UsergridClientConfig_CS_14UsergridClient">initSharedInstance(configuration:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">configuration</span> <span class="nv">configuration</span><span class="p">:</span> <span class="kt">UsergridClientConfig</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>configuration</em>
- </code>
- </td>
- <td>
- <div>
- <p>The configuration for the client to be set up with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Push%20Notifications"></a>
- <a name="//apple_ref/swift/Section/Push Notifications" class="dashAnchor"></a>
- <a href="#/Push%20Notifications">
- <h3 class="section-name">Push Notifications</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the shared <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">applyPushToken</span><span class="p">(</span><span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:pushToken:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:pushToken:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the given <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">applyPushToken</span><span class="p">(</span><span class="nv">device</span><span class="p">:</span> <span class="kt">UsergridDevice</span><span class="p">,</span> <span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>device</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridDevice</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Authorization"></a>
- <a name="//apple_ref/swift/Section/Authorization" class="dashAnchor"></a>
- <a href="#/Authorization">
- <h3 class="section-name">Authorization</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid9usingAuthFCS_12UsergridAuthCS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/usingAuth(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid9usingAuthFCS_12UsergridAuthCS_14UsergridClient">usingAuth(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the shared <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s <code>tempAuth</code> property using the passed in <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code>.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">static</span> <span class="kd">func</span> <span class="nf">usingAuth</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="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAuth</code> object to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid10usingTokenFSSCS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/usingToken(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid10usingTokenFSSCS_14UsergridClient">usingToken(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the shared <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s <code>tempAuth</code> property using the passed in token.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">static</span> <span class="kd">func</span> <span class="nf">usingToken</span><span class="p">(</span><span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The access token to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid15authForRequestsFT_GSqCS_12UsergridAuth_"></a>
- <a name="//apple_ref/swift/Method/authForRequests()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authForRequestsFT_GSqCS_12UsergridAuth_">authForRequests()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines the <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object that will be used for all outgoing requests made by the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
-<p>If there is a <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> logged in and the token of that user is valid then it will return that.</p>
-
-<p>Otherwise, if the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid8authModeOS_16UsergridAuthMode">authMode</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</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">static</span> <span class="kd">func</span> <span class="nf">authForRequests</span><span class="p">()</span> <span class="o">-></span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> if one is found or nil if not.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is contained within the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is passed in using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">auth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAppAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">auth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:setAsCurrentUser:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:setAsCurrentUser:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">setAsCurrentUser</span><span class="p">:</span><span class="kt">Bool</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>setAsCurrentUser</em>
- </code>
- </td>
- <td>
- <div>
- <p>If the authenticated user should be set as the <code>UsergridClient.currentUser</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a>
- <a name="//apple_ref/swift/Method/resetPassword(_:old:new:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:old:new:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Changes the given <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">resetPassword</span><span class="p">(</span><span class="nv">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">,</span> <span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserResetPasswordCompletion</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>user</em>
- </code>
- </td>
- <td>
- <div>
- <p>The user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>old</em>
- </code>
- </td>
- <td>
- <div>
- <p>The old password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>new</em>
- </code>
- </td>
- <td>
- <div>
- <p>The new password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_">logoutCurrentUser(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the current user of the shared instance locally and remotely using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">logoutCurrentUser</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUserAllTokens(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUserAllTokens(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the user remotely with the given tokens using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">logoutUserAllTokens</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUser(_:token:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUser(_:token:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out a user with the give UUID or username using the shared instance of <code>UsergridCient</code>.</p>
-
-<p>Passing in a token will log out the user for just that token. Passing in nil for the token will logout the user for all tokens.</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">static</span> <span class="kd">func</span> <span class="nf">logoutUser</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Generic%20Request%20Methods"></a>
- <a name="//apple_ref/swift/Section/Generic Request Methods" class="dashAnchor"></a>
- <a href="#/Generic%20Request%20Methods">
- <h3 class="section-name">Generic Request Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/sendRequest(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_">sendRequest(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Starts the <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> sending process using the shared instance of <code>UsergridCient</code>.</p>
-
-<div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>This method should only be used when you construct your own `UsergridRequest objects.</p>
-
-</div>
-
- </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">static</span> <span class="kd">func</span> <span class="nf">sendRequest</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span><span class="kt">UsergridRequest</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>request</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridRequest</code> object to send.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/GET"></a>
- <a name="//apple_ref/swift/Section/GET" class="dashAnchor"></a>
- <a href="#/GET">
- <h3 class="section-name">GET</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:uuidOrName:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:uuidOrName:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a single <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> of a given type with a specific UUID/name using the shared instance of <code>UsergridCient</code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div
<TRUNCATED>
[23/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
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>
[43/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_iOS_Tests.xcscheme
----------------------------------------------------------------------
diff --git a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_iOS_Tests.xcscheme b/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_iOS_Tests.xcscheme
deleted file mode 100644
index a6ebb1d..0000000
--- a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_iOS_Tests.xcscheme
+++ /dev/null
@@ -1,57 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
- LastUpgradeVersion = "0720"
- version = "1.3">
- <BuildAction
- parallelizeBuildables = "YES"
- buildImplicitDependencies = "YES">
- </BuildAction>
- <TestAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- shouldUseLaunchSchemeArgsEnv = "YES"
- codeCoverageEnabled = "YES">
- <Testables>
- <TestableReference
- skipped = "NO">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "630A21B71C49C473008BE87F"
- BuildableName = "UsergridSDK_iOS_Tests.xctest"
- BlueprintName = "UsergridSDK_iOS_Tests"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </TestableReference>
- </Testables>
- <AdditionalOptions>
- </AdditionalOptions>
- </TestAction>
- <LaunchAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- launchStyle = "0"
- useCustomWorkingDirectory = "NO"
- ignoresPersistentStateOnLaunch = "NO"
- debugDocumentVersioning = "YES"
- debugServiceExtension = "internal"
- allowLocationSimulation = "YES">
- <AdditionalOptions>
- </AdditionalOptions>
- </LaunchAction>
- <ProfileAction
- buildConfiguration = "Release"
- shouldUseLaunchSchemeArgsEnv = "YES"
- savedToolIdentifier = ""
- useCustomWorkingDirectory = "NO"
- debugDocumentVersioning = "YES">
- </ProfileAction>
- <AnalyzeAction
- buildConfiguration = "Debug">
- </AnalyzeAction>
- <ArchiveAction
- buildConfiguration = "Release"
- revealArchiveInOrganizer = "YES">
- </ArchiveAction>
-</Scheme>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes.html b/sdks/swift/docs/Classes.html
deleted file mode 100644
index c6b6e22..0000000
--- a/sdks/swift/docs/Classes.html
+++ /dev/null
@@ -1,702 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Classes 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 title="Classes 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" />
- Classes 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>Classes</h1>
- <p>The following classes are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK21UsergridResponseError"></a>
- <a name="//apple_ref/swift/Class/UsergridResponseError" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK21UsergridResponseError">UsergridResponseError</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A standard error object that contains details about a request failure.</p>
-
- <a href="Classes/UsergridResponseError.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridResponseError</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK15UsergridRequest"></a>
- <a name="//apple_ref/swift/Class/UsergridRequest" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK15UsergridRequest">UsergridRequest</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The UsergridRequest class incapsulates the properties that all requests made by the SDK have in common. </p>
-
-<p>This class is also functions to create <code>NSURLRequest</code> objects based on the properties of the class.</p>
-
- <a href="Classes/UsergridRequest.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridRequest</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK26UsergridAssetUploadRequest"></a>
- <a name="//apple_ref/swift/Class/UsergridAssetUploadRequest" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK26UsergridAssetUploadRequest">UsergridAssetUploadRequest</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="Classes/UsergridRequest.html">UsergridRequest</a></code> sub class which is used for uploading assets.</p>
-
- <a href="Classes/UsergridAssetUploadRequest.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridAssetUploadRequest</span><span class="p">:</span> <span class="kt">UsergridRequest</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK20UsergridClientConfig"></a>
- <a name="//apple_ref/swift/Class/UsergridClientConfig" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK20UsergridClientConfig">UsergridClientConfig</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridClientConfig</code> is used when initializing <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> objects.</p>
-
-<p>The <code>UsergridClientConfig</code> is meant for further customization of <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> objects when needed.</p>
-
- <a href="Classes/UsergridClientConfig.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridClientConfig</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK12UsergridAuth"></a>
- <a name="//apple_ref/swift/Class/UsergridAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK12UsergridAuth">UsergridAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>UsergridAuth</code> class functions to create and store authentication information used by Usergrid.</p>
-
-<p>The <code>UsergridAuth</code> sub classes, <code><a href="Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> and <code><a href="Classes/UsergridUserAuth.html">UsergridUserAuth</a></code>, provide different ways for authentication to be used in creating requests for access tokens through the SDK.</p>
-
- <a href="Classes/UsergridAuth.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK16UsergridUserAuth"></a>
- <a name="//apple_ref/swift/Class/UsergridUserAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK16UsergridUserAuth">UsergridUserAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="Classes/UsergridAuth.html">UsergridAuth</a></code> subclass used for user level authorization.</p>
-
- <a href="Classes/UsergridUserAuth.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridUserAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK15UsergridAppAuth"></a>
- <a name="//apple_ref/swift/Class/UsergridAppAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK15UsergridAppAuth">UsergridAppAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="Classes/UsergridAuth.html">UsergridAuth</a></code> subclass used for application level authorization.</p>
-
- <a href="Classes/UsergridAppAuth.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridAppAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK20UsergridFileMetaData"></a>
- <a name="//apple_ref/swift/Class/UsergridFileMetaData" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK20UsergridFileMetaData">UsergridFileMetaData</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridFileMetaData</code> is a helper class for dealing with reading <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> file meta data.</p>
-
- <a href="Classes/UsergridFileMetaData.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridFileMetaData</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span><span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK14UsergridDevice"></a>
- <a name="//apple_ref/swift/Class/UsergridDevice" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK14UsergridDevice">UsergridDevice</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridDevice</code> is an <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> subclass that encapsulates information about the current device as well as stores information about push tokens and Usergrid notifiers.</p>
-
-<p>To apply push tokens for Usergrid notifiers use the <code>UsergridClient.applyPushToken</code> method.</p>
-
- <a href="Classes/UsergridDevice.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridDevice</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK13UsergridQuery"></a>
- <a name="//apple_ref/swift/Class/UsergridQuery" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK13UsergridQuery">UsergridQuery</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridQuery</code> is builder class used to construct filtered requests to Usergrid.</p>
-
-<p><code>UsergridQuery</code> objects are then passed to <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> or <code><a href="Classes/Usergrid.html">Usergrid</a></code> methods which support <code>UsergridQuery</code> as a parameter are .GET(), .PUT(), and .DELETE().</p>
-
- <a href="Classes/UsergridQuery.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridQuery</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span><span class="kt">NSCopying</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK14UsergridEntity"></a>
- <a name="//apple_ref/swift/Class/UsergridEntity" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK14UsergridEntity">UsergridEntity</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridEntity</code> is the base class that contains a single Usergrid entity. </p>
-
-<p><code>UsergridEntity</code> maintains a set of accessor properties for standard Usergrid schema properties (e.g. name, uuid), and supports helper methods for accessing any custom properties that might exist.</p>
-
- <a href="Classes/UsergridEntity.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridEntity</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK12UsergridUser"></a>
- <a name="//apple_ref/swift/Class/UsergridUser" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK12UsergridUser">UsergridUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridUser</code> is a special subclass of <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> that supports functions and properties unique to users.</p>
-
- <a href="Classes/UsergridUser.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridUser</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK8Usergrid"></a>
- <a name="//apple_ref/swift/Class/Usergrid" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK8Usergrid">Usergrid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>Usergrid</code> class acts as a static shared instance manager for the <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> class.</p>
-
-<p>The methods and variables in this class are all static and therefore you will never need or want to initialize an instance of the <code>Usergrid</code> class.</p>
-
-<p>Use of this class depends on initialization of the shared instance of the <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> object. Because of this, before using any of the static methods
-provided you will need to call one of the shared instance initialization methods. Failure to do so will result in failure from all methods.</p>
-
- <a href="Classes/Usergrid.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">Usergrid</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK16UsergridResponse"></a>
- <a name="//apple_ref/swift/Class/UsergridResponse" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK16UsergridResponse">UsergridResponse</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridResponse</code> is the core class that handles both successful and unsuccessful HTTP responses from Usergrid. </p>
-
-<p>If a request is successful, any entities returned in the response will be automatically parsed into <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> objects and pushed to the <code>entities</code> property.</p>
-
-<p>If a request fails, the <code>UsergridResponseError.error</code> property will contain information about the problem encountered.</p>
-
- <a href="Classes/UsergridResponse.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridResponse</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK13UsergridAsset"></a>
- <a name="//apple_ref/swift/Class/UsergridAsset" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK13UsergridAsset">UsergridAsset</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
-
- <a href="Classes/UsergridAsset.html" class="slightly-smaller">See more</a>
- </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">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>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK14UsergridClient"></a>
- <a name="//apple_ref/swift/Class/UsergridClient" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK14UsergridClient">UsergridClient</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>UsergridClient</code> class is the base handler for making client connections to and managing relationships with Usergrid’s API.</p>
-
- <a href="Classes/UsergridClient.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridClient</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </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>
[22/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
deleted file mode 100644
index 8d1f6fd..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
+++ /dev/null
@@ -1,558 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuth 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/UsergridAuth" class="dashAnchor"></a>
- <a title="UsergridAuth 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" />
- UsergridAuth 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>UsergridAuth</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p>The <code>UsergridAuth</code> class functions to create and store authentication information used by Usergrid.</p>
-
-<p>The <code>UsergridAuth</code> sub classes, <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> and <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code>, provide different ways for authentication to be used in creating requests for access tokens through the SDK.</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:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_"></a>
- <a name="//apple_ref/swift/Property/accessToken" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The access token, if this <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> was authorized successfully.</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">accessToken</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:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_"></a>
- <a name="//apple_ref/swift/Property/expiry" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_">expiry</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The expires at date, if this <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> was authorized successfully and their was a expires in time stamp within the token response.</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">expiry</span> <span class="p">:</span> <span class="kt">NSDate</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridAuth8hasTokenSb"></a>
- <a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth8hasTokenSb">hasToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if an access token exists.</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">hasToken</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">accessToken</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridAuth7isValidSb"></a>
- <a name="//apple_ref/swift/Property/isValid" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth7isValidSb">isValid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if an access token exists and if the token is not expired.</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">isValid</span> <span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">hasToken</span> <span class="o">&&</span> <span class="o">!</span><span class="k">self</span><span class="o">.</span><span class="n">isExpired</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridAuth9isExpiredSb"></a>
- <a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth9isExpiredSb">isExpired</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if the access token, if one exists, is expired.</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">isExpired</span><span class="p">:</span> <span class="kt">Bool</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:FC11UsergridSDK12UsergridAuthcFT11accessTokenSS6expiryGSqCSo6NSDate__S0_"></a>
- <a name="//apple_ref/swift/Method/init(accessToken:expiry:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFT11accessTokenSS6expiryGSqCSo6NSDate__S0_">init(accessToken:expiry:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializer for a base <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object that just contains an <code><a href="../Classes/UsergridAuth.html#/s:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a></code> and an optional <code><a href="../Classes/UsergridAuth.html#/s:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_">expiry</a></code> date.</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">accessToken</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">expiry</span><span class="p">:</span><span class="kt">NSDate</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>accessToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The access token.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>expiry</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional expiry date.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridAuth.html">UsergridAuth</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:FC11UsergridSDK12UsergridAuthcFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFT5coderCSo7NSCoder_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/UsergridAuth.html">UsergridAuth</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridAuth15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuth15encodeWithCoderFCSo7NSCoderT_">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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Instance%20Methods"></a>
- <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
- <a href="#/Instance%20Methods">
- <h3 class="section-name">Instance Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridAuth7destroyFT_T_"></a>
- <a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuth7destroyFT_T_">destroy()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Destroys/removes the access token and expiry.</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">destroy</span><span class="p">()</span></code></pre>
-
- </div>
- </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>
[09/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridClient.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridClient.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridClient.html
deleted file mode 100644
index d87e6fb..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridClient.html
+++ /dev/null
@@ -1,1962 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridClient Extension 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/Extension/UsergridClient" class="dashAnchor"></a>
- <a title="UsergridClient Extension Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html"> Docs</a> (88% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> Reference</a>
- <img id="carat" src="../img/carat.png" />
- UsergridClient Extension 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/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/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/UsergridResponse.html">UsergridResponse</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="../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/UsergridEntityProperties.html">UsergridEntityProperties</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/UsergridClient.html">UsergridClient</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>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridClient</h1>
- <div class="declaration">
- <div class="Swift">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p>The <code>UsergridClient</code> class is the base handler for making client connections to and managing relationships with Usergrid’s API.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Authorization"></a>
- <a name="//apple_ref/swift/Section/Authorization" class="dashAnchor"></a>
- <a href="#/Authorization">
- <h3 class="section-name">Authorization</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authForRequestsFS0_FT_GSqCS_12UsergridAuth_"></a>
- <a name="//apple_ref/swift/Method/authForRequests()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authForRequestsFS0_FT_GSqCS_12UsergridAuth_">authForRequests()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines the <code>UsergridAuth</code> object that will be used for all outgoing requests made.</p>
-
-<p>If there is a <code>UsergridUser</code> logged in and the token of that user is valid then it will return that.</p>
-
-<p>Otherwise, if the <code>authFallback</code> is <code>.App</code>, and the <code>UsergridAppAuth</code> of the client is set and the token is valid it will return that.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authForRequests</span><span class="p">()</span> <span class="o">-></span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code>UsergridAuth</code> if one is found or nil if not.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqSS__T__T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqSS__T__T_">authenticateApp(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code>UsergridAppAuth</code> that is contained this instance of <code>UsergridCient</code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqSS__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqSS__T___T_">authenticateApp(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code>UsergridAppAuth</code> that is passed in.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAppAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqSS__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqSS__T___T_">authenticateUser(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code>UsergridUserAuth</code> that is passed in.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqSS__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:setAsCurrentUser:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqSS__T___T_">authenticateUser(_:setAsCurrentUser:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code>UsergridUserAuth</code> that is passed in.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">setAsCurrentUser</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>setAsCurrentUser</em>
- </code>
- </td>
- <td>
- <div>
- <p>If the authenticated user should be set as the <code>UsergridClient.currentUser</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFS0_FGSqFT8responseCS_16UsergridResponse_T__T_"></a>
- <a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFS0_FGSqFT8responseCS_16UsergridResponse_T__T_">logoutCurrentUser(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUserAllTokens(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUserAllTokens(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient10logoutUserFS0_FTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUser(_:token:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10logoutUserFS0_FTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUser(_:token:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/GET"></a>
- <a name="//apple_ref/swift/Section/GET" class="dashAnchor"></a>
- <a href="#/GET">
- <h3 class="section-name">GET</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:uuidOrName:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:uuidOrName:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a single <code>UsergridEntity</code> of a given type with a specific UUID/name.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>uuidOrName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The UUID or name of the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:query:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:query:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a group of <code>UsergridEntity</code> objects of a given type with an optional query.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>query</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional query to use when gathering <code>UsergridEntity</code> objects.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/PUT"></a>
- <a name="//apple_ref/swift/Section/PUT" class="dashAnchor"></a>
- <a href="#/PUT">
- <h3 class="section-name">PUT</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTSS10uuidOrNameSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/PUT(_:uuidOrName:jsonBody:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTSS10uuidOrNameSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_">PUT(_:uuidOrName:jsonBody:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates an <code>UsergridEntity</code> with the given type and UUID/name specified using the passed in jsonBody.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">PUT</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">jsonBody</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="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>uuidOrName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The UUID or name of the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionary to update the <code>UsergridEntity</code> with.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/PUT(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_">PUT(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates the passed in <code>UsergridEntity</code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">PUT</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> to update.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/PUT(_:jsonBody:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_">PUT(_:jsonBody:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates an <code>UsergridEntity</code> with the given type using the jsonBody where the UUID/name is specified inside of the jsonBody.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">PUT</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">jsonBody</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="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionary to update the <code>UsergridEntity</code> with.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTCS_13UsergridQuery8jsonBodyGVSs10DictionarySSPSs9AnyObject__15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/PUT(_:jsonBody:queryCompletion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTCS_13UsergridQuery8jsonBodyGVSs10DictionarySSPSs9AnyObject__15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_">PUT(_:jsonBody:queryCompletion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates the entities that fit the given query using the passed in jsonBody.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">PUT</span><span class="p">(</span><span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">,</span> <span class="nv">jsonBody</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="nv">queryCompletion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>query</em>
- </code>
- </td>
- <td>
- <div>
- <p>The query to use when filtering what entities to update.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionary to update with.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>queryCompletion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/POST"></a>
- <a name="//apple_ref/swift/Section/POST" class="dashAnchor"></a>
- <a href="#/POST">
- <h3 class="section-name">POST</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/POST(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_">POST(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates and posts creates an <code>UsergridEntity</code>.
-- parameter entity: The <code>UsergridEntity</code> to create.
-- parameter completion: The completion block that will be called once the request has completed.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">POST</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> to create.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTGSaCS_14UsergridEntity_18entitiesCompletionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/POST(_:entitiesCompletion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTGSaCS_14UsergridEntity_18entitiesCompletionGSqFT8responseCS_16UsergridResponse_T___T_">POST(_:entitiesCompletion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates and posts an array of <code>UsergridEntity</code> objects.</p>
-
-<p>Each <code>UsergridEntity</code> in the array much already have a type assigned and must be the same.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">POST</span><span class="p">(</span><span class="nv">entities</span><span class="p">:[</span><span class="kt">UsergridEntity</span><span class="p">],</span> <span class="nv">entitiesCompletion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entities</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> objects to create.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>entitiesCompletion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/POST(_:jsonBody:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_">POST(_:jsonBody:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates and posts an <code>UsergridEntity</code> of the given type with the given jsonBody.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">POST</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">jsonBody</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="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionary to use when creating the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS10jsonBodiesGSaGVSs10DictionarySSPSs9AnyObject___10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/POST(_:jsonBodies:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS10jsonBodiesGSaGVSs10DictionarySSPSs9AnyObject___10completionGSqFT8responseCS_16UsergridResponse_T___T_">POST(_:jsonBodies:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates and posts an array of <code>Entity</code> objects while assigning the given type to them.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">POST</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">jsonBodies</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="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionaries to use when creating the <code>UsergridEntity</code> objects.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS4nameSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/POST(_:name:jsonBody:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS4nameSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_">POST(_:name:jsonBody:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates and posts an <code>UsergridEntity</code> of the given type with a given name and the given jsonBody.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">POST</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">jsonBody</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="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionary to use when creating the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/DELETE"></a>
- <a name="//apple_ref/swift/Section/DELETE" class="dashAnchor"></a>
- <a href="#/DELETE">
- <h3 class="section-name">DELETE</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/DELETE(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_">DELETE(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Destroys the passed <code>UsergridEntity</code>.
-- parameter entity: The <code>UsergridEntity</code> to delete.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">DELETE</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> to delete.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTCS_13UsergridQuery15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/DELETE(_:queryCompletion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTCS_13UsergridQuery15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_">DELETE(_:queryCompletion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Destroys the <code>UsergridEntity</code> objects that fit the given <code>UsergridQuery</code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">DELETE</span><span class="p">(</span><span class="nv">query</span><span class="p">:</span><span class="kt">UsergridQuery</span><span class="p">,</span> <span class="nv">queryCompletion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>query</em>
- </code>
- </td>
- <td>
- <div>
- <p>The query to use when filtering what entities to delete.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>queryCompletion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/DELETE(_:uuidOrName:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">DELETE(_:uuidOrName:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Destroys the <code>UsergridEntity</code> of a given type with a specific UUID/name.
-- parameter type: The <code>UsergridEntity</code> type.
-- parameter uuidOrName: The UUID or name of the <code>UsergridEntity</code>.
-- parameter completion: The completion block that will be called once the request has completed.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">DELETE</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>uuidOrName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The UUID or name of the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Entity%20Connections"></a>
- <a name="//apple_ref/swift/Section/Entity Connections" class="dashAnchor"></a>
- <a href="#/Entity%20Connections">
- <h3 class="section-name">Entity Connections</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient7CONNECTFS0_FTCS_14UsergridEntity12relationshipSS16connectingEntityS1_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/CONNECT(_:relationship:connectingEntity:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient7CONNECTFS0_FTCS_14UsergridEntity12relationshipSS16connectingEntityS1_10completionGSqFT8responseCS_16UsergridResponse_T___T_">CONNECT(_:relationship:connectingEntity:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Connects the <code>UsergridEntity</code> objects via the relationship.
-- parameter entity: The <code>UsergridEntity</code> that will contain the connection.
-- parameter relationship: The relationship of the two entities.
-- parameter connectingEntity: The <code>UsergridEntity</code> which is connected.
-- parameter completion: The completion block that will be called once the request has completed.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">CONNECT</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">connectingEntity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> that will contain the connection.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>relationship</em>
- </code>
- </td>
- <td>
- <div>
- <p>The relationship of the two entities.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>connectingEntity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> which is connected.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient10DISCONNECTFS0_FTCS_14UsergridEntity12relationshipSS16connectingEntityS1_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/DISCONNECT(_:relationship:connectingEntity:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10DISCONNECTFS0_FTCS_14UsergridEntity12relationshipSS16connectingEntityS1_10completionGSqFT8responseCS_16UsergridResponse_T___T_">DISCONNECT(_:relationship:connectingEntity:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Disconnects the <code>UsergridEntity</code> objects via the relationship.
-- parameter entity: The <code>UsergridEntity</code> that contains the connection.
-- parameter relationship: The relationship of the two entities.
-- parameter connectingEntity: The <code>UsergridEntity</code> which is connected.
-- parameter completion: The completion block that will be called once the request has completed.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">DISCONNECT</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">connectingEntity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> that contains the connection.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>relationship</em>
- </code>
- </td>
- <td>
- <div>
- <p>The relationship of the two entities.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>connectingEntity</em>
- </code>
-
<TRUNCATED>
[17/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery.html
deleted file mode 100644
index 5b8d3e5..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridQuery.html
+++ /dev/null
@@ -1,2278 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridQuery 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/UsergridQuery" class="dashAnchor"></a>
- <a title="UsergridQuery 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" />
- UsergridQuery 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>UsergridQuery</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridQuery</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span><span class="kt">NSCopying</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridQuery</code> is builder class used to construct filtered requests to Usergrid.</p>
-
-<p><code>UsergridQuery</code> objects are then passed to <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> or <code><a href="../Classes/Usergrid.html">Usergrid</a></code> methods which support <code>UsergridQuery</code> as a parameter are .GET(), .PUT(), and .DELETE().</p>
-
- </section>
- <section class="section task-group-section">
- <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:FC11UsergridSDK13UsergridQuerycFTGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuerycFTGSqSS__S0_">init(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Desingated initializer for <code><a href="../Classes/UsergridQuery.html">UsergridQuery</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="n">_</span> <span class="nv">collectionName</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>collectionName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The collection name or <code>type</code> of entities you want to query.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridQuery.html">UsergridQuery</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/NSCopying"></a>
- <a name="//apple_ref/swift/Section/NSCopying" class="dashAnchor"></a>
- <a href="#/NSCopying">
- <h3 class="section-name">NSCopying</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery12copyWithZoneFV10ObjectiveC6NSZonePs9AnyObject_"></a>
- <a name="//apple_ref/swift/Method/copyWithZone(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery12copyWithZoneFV10ObjectiveC6NSZonePs9AnyObject_">copyWithZone(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>See the NSCopying protocol.</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">copyWithZone</span><span class="p">(</span><span class="nv">zone</span><span class="p">:</span> <span class="kt">NSZone</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AnyObject</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>zone</em>
- </code>
- </td>
- <td>
- <div>
- <p>Ignored</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>Returns a new instance that\u2019s a copy of the receiver.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Building"></a>
- <a name="//apple_ref/swift/Section/Building" class="dashAnchor"></a>
- <a href="#/Building">
- <h3 class="section-name">Building</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery5buildFTSb_SS"></a>
- <a name="//apple_ref/swift/Method/build(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery5buildFTSb_SS">build(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Constructs the string that should be appeneded to the end of the URL as a query.</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">build</span><span class="p">(</span><span class="nv">autoURLEncode</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>autoURLEncode</em>
- </code>
- </td>
- <td>
- <div>
- <p>Automatically encode the constructed string.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The constructed URL query sting.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Builder%20Methods"></a>
- <a name="//apple_ref/swift/Section/Builder Methods" class="dashAnchor"></a>
- <a href="#/Builder%20Methods">
- <h3 class="section-name">Builder Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery8containsFTSS5valueSS_DS0_"></a>
- <a name="//apple_ref/swift/Method/contains(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery8containsFTSS5valueSS_DS0_">contains(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Contains. Query: where term contains ‘val%’.</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">contains</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">containsWord</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery14containsStringFTSS5valueSS_DS0_"></a>
- <a name="//apple_ref/swift/Method/containsString(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery14containsStringFTSS5valueSS_DS0_">containsString(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Contains. Query: where term contains ‘val%’.</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">containsString</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">containsWord</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery12containsWordFTSS5valueSS_DS0_"></a>
- <a name="//apple_ref/swift/Method/containsWord(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery12containsWordFTSS5valueSS_DS0_">containsWord(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Contains. Query: where term contains ‘val%’.</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">containsWord</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addRequirement</span><span class="p">(</span><span class="n">term</span> <span class="o">+</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">SPACE</span> <span class="o">+</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">CONTAINS</span> <span class="o">+</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">SPACE</span> <
span class="o">+</span> <span class="p">((</span><span class="n">value</span><span class="o">.</span><span class="nf">isUuid</span><span class="p">())</span> <span class="p">?</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">EMPTY_STRING</span> <span class="p">:</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">APOSTROPHE</span><span class="p">)</span> <span class="o">+</span> <span class="n">value</span> <span class="o">+</span> <span class="p">((</span><span class="n">value</span><span class="o">.</span><span class="nf">isUuid</span><span class="p">())</span> <span class="p">?</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">EMPTY_STRING</span> <span class="p">:</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">APOSTROPHE</span><span class="p">))</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery9ascendingFSSDS0_"></a>
- <a name="//apple_ref/swift/Method/ascending(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery9ascendingFSSDS0_">ascending(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort ascending. Query:. order by term asc.</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">ascending</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">asc</span><span class="p">(</span><span class="n">term</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery3ascFSSDS0_"></a>
- <a name="//apple_ref/swift/Method/asc(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3ascFSSDS0_">asc(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort ascending. Query:. order by term asc.</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">asc</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">sort</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">sortOrder</span><span class="p">:</span> <span class="o">.</span><span class="kt">Asc</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery10descendingFSSDS0_"></a>
- <a name="//apple_ref/swift/Method/descending(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery10descendingFSSDS0_">descending(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort descending. Query: order by term desc</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">descending</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">desc</span><span class="p">(</span><span class="n">term</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery4descFSSDS0_"></a>
- <a name="//apple_ref/swift/Method/desc(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery4descFSSDS0_">desc(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort descending. Query: order by term desc</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">desc</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">sort</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">sortOrder</span><span class="p">:</span> <span class="o">.</span><span class="kt">Desc</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery6filterFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/filter(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery6filterFTSS5valuePs9AnyObject__DS0_">filter(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Filter (or Equal-to). Query: where term = ‘value’.</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">filter</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery6equalsFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/equals(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery6equalsFTSS5valuePs9AnyObject__DS0_">equals(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Equal-to. Query: where term = ‘value’.</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">equals</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery2eqFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/eq(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery2eqFTSS5valuePs9AnyObject__DS0_">eq(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Equal-to. Query: where term = ‘value’.</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">eq</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addOperationRequirement</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">operation</span><span class="p">:</span><span class="o">.</span><span class="kt">Equal</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery11greaterThanFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/greaterThan(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery11greaterThanFTSS5valuePs9AnyObject__DS0_">greaterThan(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Greater-than. Query: where term > ‘value’.</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">greaterThan</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">gt</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery2gtFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/gt(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery2gtFTSS5valuePs9AnyObject__DS0_">gt(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Greater-than. Query: where term > ‘value’.</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">gt</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addOperationRequirement</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">operation</span><span class="p">:</span><span class="o">.</span><span class="kt">GreaterThan</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery18greaterThanOrEqualFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/greaterThanOrEqual(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery18greaterThanOrEqualFTSS5valuePs9AnyObject__DS0_">greaterThanOrEqual(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Greater-than-or-equal-to. Query: where term >= ‘value’.</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">greaterThanOrEqual</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">gte</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery3gteFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/gte(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3gteFTSS5valuePs9AnyObject__DS0_">gte(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Greater-than-or-equal-to. Query: where term >= ‘value’.</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">gte</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addOperationRequirement</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">operation</span><span class="p">:</span><span class="o">.</span><span class="kt">GreaterThanEqualTo</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery8lessThanFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/lessThan(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery8lessThanFTSS5valuePs9AnyObject__DS0_">lessThan(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Less-than. Query: where term < ‘value’.</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">lessThan</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">lt</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery2ltFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/lt(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery2ltFTSS5valuePs9AnyObject__DS0_">lt(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Less-than. Query: where term < ‘value’.</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">lt</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addOperationRequirement</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">operation</span><span class="p">:</span><span class="o">.</span><span class="kt">LessThan</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery15lessThanOrEqualFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/lessThanOrEqual(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery15lessThanOrEqualFTSS5valuePs9AnyObject__DS0_">lessThanOrEqual(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Less-than-or-equal-to. Query: where term <= ‘value’.</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">lessThanOrEqual</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">lte</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery3lteFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/lte(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3lteFTSS5valuePs9AnyObject__DS0_">lte(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Less-than-or-equal-to. Query: where term <= ‘value’.</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">lte</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addOperationRequirement</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">operation</span><span class="p">:</span><span class="o">.</span><span class="kt">LessThanEqualTo</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery14locationWithinFTSf8latitudeSf9longitudeSf_DS0_"></a>
- <a name="//apple_ref/swift/Method/locationWithin(_:latitude:longitude:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery14locationWithinFTSf8latitudeSf9longitudeSf_DS0_">locationWithin(_:latitude:longitude:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Contains. Query: location within val of lat, long.</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">locationWithin</span><span class="p">(</span><span class="nv">distance</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">latitude</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">longitude</span><span class="p">:</span> <span class="kt">Float</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>distance</em>
- </code>
- </td>
- <td>
- <div>
- <p>The distance from the latitude and longitude.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>latitude</em>
- </code>
- </td>
- <td>
- <div>
- <p>The latitude.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>longitude</em>
- </code>
- </td>
- <td>
- <div>
- <p>The longitude.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery2orFT_DS0_"></a>
- <a name="//apple_ref/swift/Method/or()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery2orFT_DS0_">or()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Or operation for conditional queries.</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">or</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery3andFT_DS0_"></a>
- <a name="//apple_ref/swift/Method/and()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3andFT_DS0_">and()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>And operation for conditional queries.</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">and</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery3notFT_DS0_"></a>
- <a name="//apple_ref/swift/Method/not()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3notFT_DS0_">not()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Not operation for conditional queries.</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">not</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery4sortFTSS9sortOrderOS_22UsergridQuerySortOrder_DS0_"></a>
- <a name="//apple_ref/swift/Method/sort(_:sortOrder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery4sortFTSS9sortOrderOS_22UsergridQuerySortOrder_DS0_">sort(_:sortOrder:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort. Query: order by term <code>sortOrder</code></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">sort</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">sortOrder</span><span class="p">:</span> <span class="kt">UsergridQuerySortOrder</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>sortOrder</em>
- </code>
- </td>
- <td>
- <div>
- <p>The order.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
-
<TRUNCATED>
[39/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridClient.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridClient.html b/sdks/swift/docs/Classes/UsergridClient.html
deleted file mode 100644
index 09c2175..0000000
--- a/sdks/swift/docs/Classes/UsergridClient.html
+++ /dev/null
@@ -1,3873 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridClient 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/UsergridClient" class="dashAnchor"></a>
- <a title="UsergridClient 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" />
- UsergridClient 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>UsergridClient</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p>The <code>UsergridClient</code> class is the base handler for making client connections to and managing relationships with Usergrid’s API.</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:vC11UsergridSDK14UsergridClient6configCS_20UsergridClientConfig"></a>
- <a name="//apple_ref/swift/Property/config" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient6configCS_20UsergridClientConfig">config</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The configuration object used by the client.</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">config</span><span class="p">:</span> <span class="kt">UsergridClientConfig</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient5appIdSS"></a>
- <a name="//apple_ref/swift/Property/appId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient5appIdSS">appId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application identifier.</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">appId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">appId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient5orgIdSS"></a>
- <a name="//apple_ref/swift/Property/orgId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient5orgIdSS">orgId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The organization identifier.</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">orgId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">orgId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient7baseUrlSS"></a>
- <a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient7baseUrlSS">baseUrl</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The base URL that all calls will be made with.</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">baseUrl</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">baseUrl</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient12clientAppURLSS"></a>
- <a name="//apple_ref/swift/Property/clientAppURL" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient12clientAppURLSS">clientAppURL</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The constructed URL string based on the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient7baseUrlSS">baseUrl</a></code>, <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient5orgIdSS">orgId</a></code>, and <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient5appIdSS">appId</a></code>.</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">clientAppURL</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="s">"</span><span class="se">\(</span><span class="n">baseUrl</span><span class="se">)</span><span class="s">/</span><span class="se">\(</span><span class="n">orgId</span><span class="se">)</span><span class="s">/</span><span class="se">\(</span><span class="n">appId</span><span class="se">)</span><span class="s">"</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient28persistCurrentUserInKeychainSb"></a>
- <a name="//apple_ref/swift/Property/persistCurrentUserInKeychain" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Whether or not the current user will be saved and restored from the keychain.</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">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_"></a>
- <a name="//apple_ref/swift/Property/currentUser" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">currentUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The currently logged in <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">currentUser</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient8userAuthGSqCS_16UsergridUserAuth_"></a>
- <a name="//apple_ref/swift/Property/userAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient8userAuthGSqCS_16UsergridUserAuth_">userAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> which consists of the token information from the <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">currentUser</a></code> property.</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">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">currentUser</span><span class="p">?</span><span class="o">.</span><span class="n">auth</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_"></a>
- <a name="//apple_ref/swift/Property/appAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_">appAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application level <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object. Can be set manually but must call <code>authenticateApp</code> to retrive token.</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">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode"></a>
- <a name="//apple_ref/swift/Property/authMode" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode">authMode</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent, if any.</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">authMode</span><span class="p">:</span> <span class="kt">UsergridAuthMode</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:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS_S0_">init(orgId:appId:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes instances of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</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>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS7baseUrlSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:baseUrl:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS7baseUrlSS_S0_">init(orgId:appId:baseUrl:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes instances of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">baseUrl</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>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>baseUrl</em>
- </code>
- </td>
- <td>
- <div>
- <p>The base URL that all calls will be made with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClientcFT13configurationCS_20UsergridClientConfig_S0_"></a>
- <a name="//apple_ref/swift/Method/init(configuration:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT13configurationCS_20UsergridClientConfig_S0_">init(configuration:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes instances of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">configuration</span><span class="p">:</span><span class="kt">UsergridClientConfig</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>configuration</em>
- </code>
- </td>
- <td>
- <div>
- <p>The configuration for the client to be set up with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</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:FC11UsergridSDK14UsergridClientcFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT5coderCSo7NSCoder_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">public</span> <span class="kd">required</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/UsergridClient.html">UsergridClient</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15encodeWithCoderFCSo7NSCoderT_">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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Device%20Registration/Push%20Notifications"></a>
- <a name="//apple_ref/swift/Section/Device Registration/Push Notifications" class="dashAnchor"></a>
- <a href="#/Device%20Registration/Push%20Notifications">
- <h3 class="section-name">Device Registration/Push Notifications</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the shared <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance.</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">applyPushToken</span><span class="p">(</span><span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:pushToken:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:pushToken:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the given <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance.</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">applyPushToken</span><span class="p">(</span><span class="nv">device</span><span class="p">:</span> <span class="kt">UsergridDevice</span><span class="p">,</span> <span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>device</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridDevice</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Authorization%20and%20User%20Management"></a>
- <a name="//apple_ref/swift/Section/Authorization and User Management" class="dashAnchor"></a>
- <a href="#/Authorization%20and%20User%20Management">
- <h3 class="section-name">Authorization and User Management</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authForRequestsFT_GSqCS_12UsergridAuth_"></a>
- <a name="//apple_ref/swift/Method/authForRequests()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authForRequestsFT_GSqCS_12UsergridAuth_">authForRequests()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines the <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object that will be used for all outgoing requests made.</p>
-
-<p>If there is a valid temporary <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> set by the functions <code>usingAuth</code> or <code>usingToken</code> it will return that.</p>
-
-<p>If there is a <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> logged in and the token of that user is valid then it will return that.</p>
-
-<p>Otherwise, if the <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode">authMode</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</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">authForRequests</span><span class="p">()</span> <span class="o">-></span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> if one is found or nil if not.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient9usingAuthFCS_12UsergridAuthDS0_"></a>
- <a name="//apple_ref/swift/Method/usingAuth(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient9usingAuthFCS_12UsergridAuthDS0_">usingAuth(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the client’s <code>tempAuth</code> property using the passed in <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code>.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">usingAuth</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="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAuth</code> object to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient10usingTokenFSSDS0_"></a>
- <a name="//apple_ref/swift/Method/usingToken(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10usingTokenFSSDS0_">usingToken(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the client’s <code>tempAuth</code> property using the passed in token.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">usingToken</span><span class="p">(</span><span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The access token to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is contained this instance of <code>UsergridCient</code>.</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">authenticateApp</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is passed in.</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">authenticateApp</span><span class="p">(</span><span class="nv">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAppAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in.</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">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:setAsCurrentUser:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:setAsCurrentUser:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in.</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">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">setAsCurrentUser</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>setAsCurrentUser</em>
- </code>
- </td>
- <td>
- <div>
- <p>If the authenticated user should be set as the <code>UsergridClient.currentUser</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a>
- <a name="//apple_ref/swift/Method/resetPassword(_:old:new:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:old:new:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Changes the given <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password.</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">resetPassword</span><span class="p">(</span><span class="nv">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">,</span> <span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserResetPasswordCompletion</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>user</em>
- </code>
- </td>
- <td>
- <div>
- <p>The user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>old</em>
- </code>
- </td>
- <td>
- <div>
- <p>The old password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>new</em>
- </code>
- </td>
- <td>
- <div>
- <p>The new password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_">logoutCurrentUser(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the current user locally and remotely.</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">logoutCurrentUser</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUserAllTokens(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUserAllTokens(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the user remotely with the given tokens.</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">logoutUserAllTokens</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUser(_:token:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUser(_:token:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out a user with the give UUID or username using the shared instance of <code>UsergridCient</code>.</p>
-
-<p>Passing in a token will log out the user for just that token. Passing in nil for the token will logout the user for all tokens.</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">logoutUser</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Generic%20Request%20Methods"></a>
- <a name="//apple_ref/swift/Section/Generic Request Methods" class="dashAnchor"></a>
- <a href="#/Generic%20Request%20Methods">
- <h3 class="section-name">Generic Request Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/sendRequest(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_">sendRequest(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Starts the <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> sending process.</p>
-
-<div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>This method should only be used when you construct your own <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> objects.</p>
-
-</div>
-
- </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">sendRequest</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span><span class="kt">UsergridRequest</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>request</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridRequest</code> object to send.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/GET"></a>
- <a name="//apple_ref/swift/Section/GET" class="dashAnchor"></a>
- <a href="#/GET">
- <h3 class="section-name">GET</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:uuidOrName:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:uuidOrName:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a single <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> of a given type with a specific UUID/name.</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="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class
<TRUNCATED>
[44/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/UsergridSDK.xcodeproj/project.pbxproj
----------------------------------------------------------------------
diff --git a/sdks/swift/UsergridSDK.xcodeproj/project.pbxproj b/sdks/swift/UsergridSDK.xcodeproj/project.pbxproj
deleted file mode 100644
index 338835c..0000000
--- a/sdks/swift/UsergridSDK.xcodeproj/project.pbxproj
+++ /dev/null
@@ -1,1179 +0,0 @@
-// !$*UTF8*$!
-{
- archiveVersion = 1;
- classes = {
- };
- objectVersion = 46;
- objects = {
-
-/* Begin PBXBuildFile section */
- 630A21821C49BDD3008BE87F /* AUTH_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5A1BBC528E009D4196 /* AUTH_Tests.swift */; };
- 630A21831C49BDDE008BE87F /* ASSET_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F591BBC528E009D4196 /* ASSET_Tests.swift */; };
- 630A21841C49BDDE008BE87F /* ClientCreationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5B1BBC528E009D4196 /* ClientCreationTests.swift */; };
- 630A21851C49BDDE008BE87F /* CONNECTION_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6343823D1BC2F042008624BE /* CONNECTION_Tests.swift */; };
- 630A21861C49BDDE008BE87F /* Entity_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5C1BBC528E009D4196 /* Entity_Tests.swift */; };
- 630A21871C49BDDE008BE87F /* GET_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5D1BBC528E009D4196 /* GET_Tests.swift */; };
- 630A21891C49BDDE008BE87F /* PUT_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F601BBC528E009D4196 /* PUT_Tests.swift */; };
- 630A218A1C49BDDE008BE87F /* User_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F631BBC528E009D4196 /* User_Tests.swift */; };
- 630A219A1C49BF13008BE87F /* TestAssets in Resources */ = {isa = PBXBuildFile; fileRef = 63AF0F7D1BBC5692009D4196 /* TestAssets */; };
- 630A21A41C49BFFC008BE87F /* UsergridSDK.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 631920451C48436500F99E86 /* UsergridSDK.framework */; };
- 630A21AB1C49C011008BE87F /* AUTH_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5A1BBC528E009D4196 /* AUTH_Tests.swift */; };
- 630A21AC1C49C011008BE87F /* ClientCreationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5B1BBC528E009D4196 /* ClientCreationTests.swift */; };
- 630A21AD1C49C011008BE87F /* CONNECTION_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6343823D1BC2F042008624BE /* CONNECTION_Tests.swift */; };
- 630A21AE1C49C011008BE87F /* Entity_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5C1BBC528E009D4196 /* Entity_Tests.swift */; };
- 630A21AF1C49C011008BE87F /* GET_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5D1BBC528E009D4196 /* GET_Tests.swift */; };
- 630A21B11C49C011008BE87F /* PUT_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F601BBC528E009D4196 /* PUT_Tests.swift */; };
- 630A21B21C49C011008BE87F /* User_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F631BBC528E009D4196 /* User_Tests.swift */; };
- 630A21B31C49C013008BE87F /* TestAssets in Resources */ = {isa = PBXBuildFile; fileRef = 63AF0F7D1BBC5692009D4196 /* TestAssets */; };
- 630A21BD1C49C473008BE87F /* UsergridSDK.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 63AF0E881BBC38FB009D4196 /* UsergridSDK.framework */; };
- 630A21C41C49C4C0008BE87F /* ASSET_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F591BBC528E009D4196 /* ASSET_Tests.swift */; };
- 630A21C51C49C4C0008BE87F /* AUTH_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5A1BBC528E009D4196 /* AUTH_Tests.swift */; };
- 630A21C61C49C4C0008BE87F /* ClientCreationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5B1BBC528E009D4196 /* ClientCreationTests.swift */; };
- 630A21C71C49C4C0008BE87F /* CONNECTION_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6343823D1BC2F042008624BE /* CONNECTION_Tests.swift */; };
- 630A21C81C49C4C0008BE87F /* Entity_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5C1BBC528E009D4196 /* Entity_Tests.swift */; };
- 630A21C91C49C4C0008BE87F /* GET_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F5D1BBC528E009D4196 /* GET_Tests.swift */; };
- 630A21CB1C49C4C0008BE87F /* PUT_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F601BBC528E009D4196 /* PUT_Tests.swift */; };
- 630A21CC1C49C4C0008BE87F /* User_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F631BBC528E009D4196 /* User_Tests.swift */; };
- 630A21CD1C49C4CC008BE87F /* TestAssets in Resources */ = {isa = PBXBuildFile; fileRef = 63AF0F7D1BBC5692009D4196 /* TestAssets */; };
- 6313CA2E1BD80BB9004451EE /* UsergridEnums.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6313CA2D1BD80BB9004451EE /* UsergridEnums.swift */; };
- 6319202C1C48436500F99E86 /* UsergridResponseError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63EE60D81C404AB700AFC2CF /* UsergridResponseError.swift */; };
- 6319202D1C48436500F99E86 /* UsergridRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63F36F0E1C458AAE00CEEF54 /* UsergridRequest.swift */; };
- 6319202E1C48436500F99E86 /* UsergridClientConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6343823F1BC30138008624BE /* UsergridClientConfig.swift */; };
- 631920311C48436500F99E86 /* UsergridAuth.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F411BBC4EF6009D4196 /* UsergridAuth.swift */; };
- 631920321C48436500F99E86 /* UsergridFileMetaData.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63A7F2611BC4278200596156 /* UsergridFileMetaData.swift */; };
- 631920331C48436500F99E86 /* UsergridDevice.swift in Sources */ = {isa = PBXBuildFile; fileRef = 636A4BE11BDA8D9E0061000A /* UsergridDevice.swift */; };
- 631920341C48436500F99E86 /* UsergridQuery.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F441BBC4EF6009D4196 /* UsergridQuery.swift */; };
- 631920361C48436500F99E86 /* UsergridEntity.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F431BBC4EF6009D4196 /* UsergridEntity.swift */; };
- 631920381C48436500F99E86 /* UsergridUser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F481BBC4EF6009D4196 /* UsergridUser.swift */; };
- 631920391C48436500F99E86 /* Usergrid.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F3F1BBC4EF6009D4196 /* Usergrid.swift */; };
- 6319203A1C48436500F99E86 /* UsergridResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F461BBC4EF6009D4196 /* UsergridResponse.swift */; };
- 6319203C1C48436500F99E86 /* UsergridEnums.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6313CA2D1BD80BB9004451EE /* UsergridEnums.swift */; };
- 6319203D1C48436500F99E86 /* UsergridAsset.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F401BBC4EF6009D4196 /* UsergridAsset.swift */; };
- 6319203E1C48436500F99E86 /* UsergridClient.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F421BBC4EF6009D4196 /* UsergridClient.swift */; };
- 631920501C49BC0700F99E86 /* UsergridSDK.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 63EE610B1C406E1600AFC2CF /* UsergridSDK.framework */; };
- 634382401BC30138008624BE /* UsergridClientConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6343823F1BC30138008624BE /* UsergridClientConfig.swift */; };
- 636A4BE21BDA8D9E0061000A /* UsergridDevice.swift in Sources */ = {isa = PBXBuildFile; fileRef = 636A4BE11BDA8D9E0061000A /* UsergridDevice.swift */; };
- 639B4BF31C3DD85A005E26E7 /* UsergridSDK.h in Headers */ = {isa = PBXBuildFile; fileRef = 63AF0F471BBC4EF6009D4196 /* UsergridSDK.h */; settings = {ATTRIBUTES = (Public, ); }; };
- 639B4BF41C3DD90D005E26E7 /* UsergridAsset.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F401BBC4EF6009D4196 /* UsergridAsset.swift */; };
- 639B4BF51C3DD915005E26E7 /* UsergridAuth.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F411BBC4EF6009D4196 /* UsergridAuth.swift */; };
- 639B4BF61C3DD915005E26E7 /* UsergridDevice.swift in Sources */ = {isa = PBXBuildFile; fileRef = 636A4BE11BDA8D9E0061000A /* UsergridDevice.swift */; };
- 639B4BF71C3DD915005E26E7 /* UsergridEntity.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F431BBC4EF6009D4196 /* UsergridEntity.swift */; };
- 639B4BF81C3DD915005E26E7 /* UsergridEnums.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6313CA2D1BD80BB9004451EE /* UsergridEnums.swift */; };
- 639B4BF91C3DD915005E26E7 /* UsergridFileMetaData.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63A7F2611BC4278200596156 /* UsergridFileMetaData.swift */; };
- 639B4BFA1C3DD915005E26E7 /* UsergridQuery.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F441BBC4EF6009D4196 /* UsergridQuery.swift */; };
- 639B4BFB1C3DD915005E26E7 /* UsergridResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F461BBC4EF6009D4196 /* UsergridResponse.swift */; };
- 639B4BFC1C3DD915005E26E7 /* UsergridUser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F481BBC4EF6009D4196 /* UsergridUser.swift */; };
- 639B4C021C3DD91A005E26E7 /* Usergrid.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F3F1BBC4EF6009D4196 /* Usergrid.swift */; };
- 639B4C031C3DD91A005E26E7 /* UsergridClient.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F421BBC4EF6009D4196 /* UsergridClient.swift */; };
- 639B4C041C3DD91A005E26E7 /* UsergridClientConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6343823F1BC30138008624BE /* UsergridClientConfig.swift */; };
- 63A7F2621BC4278200596156 /* UsergridFileMetaData.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63A7F2611BC4278200596156 /* UsergridFileMetaData.swift */; };
- 63AF0F4A1BBC4EF6009D4196 /* Usergrid.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F3F1BBC4EF6009D4196 /* Usergrid.swift */; };
- 63AF0F4B1BBC4EF6009D4196 /* UsergridAsset.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F401BBC4EF6009D4196 /* UsergridAsset.swift */; };
- 63AF0F4C1BBC4EF6009D4196 /* UsergridAuth.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F411BBC4EF6009D4196 /* UsergridAuth.swift */; };
- 63AF0F4D1BBC4EF6009D4196 /* UsergridClient.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F421BBC4EF6009D4196 /* UsergridClient.swift */; };
- 63AF0F4E1BBC4EF6009D4196 /* UsergridEntity.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F431BBC4EF6009D4196 /* UsergridEntity.swift */; };
- 63AF0F4F1BBC4EF6009D4196 /* UsergridQuery.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F441BBC4EF6009D4196 /* UsergridQuery.swift */; };
- 63AF0F511BBC4EF6009D4196 /* UsergridResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F461BBC4EF6009D4196 /* UsergridResponse.swift */; };
- 63AF0F531BBC4EF6009D4196 /* UsergridUser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F481BBC4EF6009D4196 /* UsergridUser.swift */; };
- 63E7DD2F1C514CA200D84B12 /* UsergridAssetRequestWrapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2A1C514CA200D84B12 /* UsergridAssetRequestWrapper.swift */; };
- 63E7DD301C514CA200D84B12 /* UsergridAssetRequestWrapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2A1C514CA200D84B12 /* UsergridAssetRequestWrapper.swift */; };
- 63E7DD311C514CA200D84B12 /* UsergridAssetRequestWrapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2A1C514CA200D84B12 /* UsergridAssetRequestWrapper.swift */; };
- 63E7DD321C514CA200D84B12 /* UsergridAssetRequestWrapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2A1C514CA200D84B12 /* UsergridAssetRequestWrapper.swift */; };
- 63E7DD331C514CA200D84B12 /* UsergridExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2B1C514CA200D84B12 /* UsergridExtensions.swift */; };
- 63E7DD341C514CA200D84B12 /* UsergridExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2B1C514CA200D84B12 /* UsergridExtensions.swift */; };
- 63E7DD351C514CA200D84B12 /* UsergridExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2B1C514CA200D84B12 /* UsergridExtensions.swift */; };
- 63E7DD361C514CA200D84B12 /* UsergridExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2B1C514CA200D84B12 /* UsergridExtensions.swift */; };
- 63E7DD371C514CA200D84B12 /* UsergridKeychainHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2C1C514CA200D84B12 /* UsergridKeychainHelpers.swift */; };
- 63E7DD381C514CA200D84B12 /* UsergridKeychainHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2C1C514CA200D84B12 /* UsergridKeychainHelpers.swift */; };
- 63E7DD391C514CA200D84B12 /* UsergridKeychainHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2C1C514CA200D84B12 /* UsergridKeychainHelpers.swift */; };
- 63E7DD3A1C514CA200D84B12 /* UsergridKeychainHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2C1C514CA200D84B12 /* UsergridKeychainHelpers.swift */; };
- 63E7DD3B1C514CA200D84B12 /* UsergridRequestManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2D1C514CA200D84B12 /* UsergridRequestManager.swift */; };
- 63E7DD3C1C514CA200D84B12 /* UsergridRequestManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2D1C514CA200D84B12 /* UsergridRequestManager.swift */; };
- 63E7DD3D1C514CA200D84B12 /* UsergridRequestManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2D1C514CA200D84B12 /* UsergridRequestManager.swift */; };
- 63E7DD3E1C514CA200D84B12 /* UsergridRequestManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2D1C514CA200D84B12 /* UsergridRequestManager.swift */; };
- 63E7DD3F1C514CA200D84B12 /* UsergridSessionDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2E1C514CA200D84B12 /* UsergridSessionDelegate.swift */; };
- 63E7DD401C514CA200D84B12 /* UsergridSessionDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2E1C514CA200D84B12 /* UsergridSessionDelegate.swift */; };
- 63E7DD411C514CA200D84B12 /* UsergridSessionDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2E1C514CA200D84B12 /* UsergridSessionDelegate.swift */; };
- 63E7DD421C514CA200D84B12 /* UsergridSessionDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD2E1C514CA200D84B12 /* UsergridSessionDelegate.swift */; };
- 63EE60D91C404AB700AFC2CF /* UsergridResponseError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63EE60D81C404AB700AFC2CF /* UsergridResponseError.swift */; };
- 63EE60DA1C404AB700AFC2CF /* UsergridResponseError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63EE60D81C404AB700AFC2CF /* UsergridResponseError.swift */; };
- 63EE60F31C406E1600AFC2CF /* UsergridResponseError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63EE60D81C404AB700AFC2CF /* UsergridResponseError.swift */; };
- 63EE60F41C406E1600AFC2CF /* UsergridClientConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6343823F1BC30138008624BE /* UsergridClientConfig.swift */; };
- 63EE60F71C406E1600AFC2CF /* UsergridAuth.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F411BBC4EF6009D4196 /* UsergridAuth.swift */; };
- 63EE60F81C406E1600AFC2CF /* UsergridFileMetaData.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63A7F2611BC4278200596156 /* UsergridFileMetaData.swift */; };
- 63EE60F91C406E1600AFC2CF /* UsergridDevice.swift in Sources */ = {isa = PBXBuildFile; fileRef = 636A4BE11BDA8D9E0061000A /* UsergridDevice.swift */; };
- 63EE60FA1C406E1600AFC2CF /* UsergridQuery.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F441BBC4EF6009D4196 /* UsergridQuery.swift */; };
- 63EE60FC1C406E1600AFC2CF /* UsergridEntity.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F431BBC4EF6009D4196 /* UsergridEntity.swift */; };
- 63EE60FE1C406E1600AFC2CF /* UsergridUser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F481BBC4EF6009D4196 /* UsergridUser.swift */; };
- 63EE60FF1C406E1600AFC2CF /* Usergrid.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F3F1BBC4EF6009D4196 /* Usergrid.swift */; };
- 63EE61001C406E1600AFC2CF /* UsergridResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F461BBC4EF6009D4196 /* UsergridResponse.swift */; };
- 63EE61021C406E1600AFC2CF /* UsergridEnums.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6313CA2D1BD80BB9004451EE /* UsergridEnums.swift */; };
- 63EE61031C406E1600AFC2CF /* UsergridAsset.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F401BBC4EF6009D4196 /* UsergridAsset.swift */; };
- 63EE61041C406E1600AFC2CF /* UsergridClient.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63AF0F421BBC4EF6009D4196 /* UsergridClient.swift */; };
- 63EE610D1C406E2200AFC2CF /* UsergridSDK.h in Headers */ = {isa = PBXBuildFile; fileRef = 63AF0F471BBC4EF6009D4196 /* UsergridSDK.h */; settings = {ATTRIBUTES = (Public, ); }; };
- 63F36F0F1C458AAE00CEEF54 /* UsergridRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63F36F0E1C458AAE00CEEF54 /* UsergridRequest.swift */; };
- 63F36F101C458AAE00CEEF54 /* UsergridRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63F36F0E1C458AAE00CEEF54 /* UsergridRequest.swift */; };
- 63F36F111C458AAE00CEEF54 /* UsergridRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63F36F0E1C458AAE00CEEF54 /* UsergridRequest.swift */; };
-/* End PBXBuildFile section */
-
-/* Begin PBXContainerItemProxy section */
- 630A21A51C49BFFC008BE87F /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 63AF0E7F1BBC38FB009D4196 /* Project object */;
- proxyType = 1;
- remoteGlobalIDString = 6319202A1C48436500F99E86;
- remoteInfo = "UsergridSDK OSX";
- };
- 630A21BE1C49C473008BE87F /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 63AF0E7F1BBC38FB009D4196 /* Project object */;
- proxyType = 1;
- remoteGlobalIDString = 63AF0E871BBC38FB009D4196;
- remoteInfo = "UsergridSDK iOS";
- };
- 631920511C49BC0700F99E86 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 63AF0E7F1BBC38FB009D4196 /* Project object */;
- proxyType = 1;
- remoteGlobalIDString = 63EE60F11C406E1600AFC2CF;
- remoteInfo = "UsergridSDK tvOS";
- };
-/* End PBXContainerItemProxy section */
-
-/* Begin PBXFileReference section */
- 630A219F1C49BFFC008BE87F /* UsergridSDK_OSX_Tests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = UsergridSDK_OSX_Tests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
- 630A21B81C49C473008BE87F /* UsergridSDK_iOS_Tests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = UsergridSDK_iOS_Tests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
- 6313CA2D1BD80BB9004451EE /* UsergridEnums.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridEnums.swift; sourceTree = "<group>"; };
- 631920451C48436500F99E86 /* UsergridSDK.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = UsergridSDK.framework; sourceTree = BUILT_PRODUCTS_DIR; };
- 6319204B1C49BC0700F99E86 /* UsergridSDK_TVOS_Tests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = UsergridSDK_TVOS_Tests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
- 6343823D1BC2F042008624BE /* CONNECTION_Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CONNECTION_Tests.swift; sourceTree = "<group>"; };
- 6343823F1BC30138008624BE /* UsergridClientConfig.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridClientConfig.swift; sourceTree = "<group>"; };
- 636A4BE11BDA8D9E0061000A /* UsergridDevice.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridDevice.swift; sourceTree = "<group>"; };
- 639B4BEB1C3DD6CF005E26E7 /* UsergridSDK.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = UsergridSDK.framework; sourceTree = BUILT_PRODUCTS_DIR; };
- 63A7F2611BC4278200596156 /* UsergridFileMetaData.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridFileMetaData.swift; sourceTree = "<group>"; };
- 63AF0E881BBC38FB009D4196 /* UsergridSDK.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = UsergridSDK.framework; sourceTree = BUILT_PRODUCTS_DIR; };
- 63AF0F3E1BBC4EF6009D4196 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
- 63AF0F3F1BBC4EF6009D4196 /* Usergrid.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Usergrid.swift; sourceTree = "<group>"; };
- 63AF0F401BBC4EF6009D4196 /* UsergridAsset.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridAsset.swift; sourceTree = "<group>"; };
- 63AF0F411BBC4EF6009D4196 /* UsergridAuth.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridAuth.swift; sourceTree = "<group>"; };
- 63AF0F421BBC4EF6009D4196 /* UsergridClient.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridClient.swift; sourceTree = "<group>"; };
- 63AF0F431BBC4EF6009D4196 /* UsergridEntity.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridEntity.swift; sourceTree = "<group>"; };
- 63AF0F441BBC4EF6009D4196 /* UsergridQuery.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridQuery.swift; sourceTree = "<group>"; };
- 63AF0F461BBC4EF6009D4196 /* UsergridResponse.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridResponse.swift; sourceTree = "<group>"; };
- 63AF0F471BBC4EF6009D4196 /* UsergridSDK.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = UsergridSDK.h; sourceTree = "<group>"; };
- 63AF0F481BBC4EF6009D4196 /* UsergridUser.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridUser.swift; sourceTree = "<group>"; };
- 63AF0F591BBC528E009D4196 /* ASSET_Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ASSET_Tests.swift; sourceTree = "<group>"; };
- 63AF0F5A1BBC528E009D4196 /* AUTH_Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AUTH_Tests.swift; sourceTree = "<group>"; };
- 63AF0F5B1BBC528E009D4196 /* ClientCreationTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ClientCreationTests.swift; sourceTree = "<group>"; };
- 63AF0F5C1BBC528E009D4196 /* Entity_Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Entity_Tests.swift; sourceTree = "<group>"; };
- 63AF0F5D1BBC528E009D4196 /* GET_Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = GET_Tests.swift; sourceTree = "<group>"; };
- 63AF0F5E1BBC528E009D4196 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
- 63AF0F601BBC528E009D4196 /* PUT_Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PUT_Tests.swift; sourceTree = "<group>"; };
- 63AF0F631BBC528E009D4196 /* User_Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = User_Tests.swift; sourceTree = "<group>"; };
- 63AF0F7D1BBC5692009D4196 /* TestAssets */ = {isa = PBXFileReference; lastKnownFileType = folder; path = TestAssets; sourceTree = "<group>"; };
- 63E7DD2A1C514CA200D84B12 /* UsergridAssetRequestWrapper.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridAssetRequestWrapper.swift; sourceTree = "<group>"; };
- 63E7DD2B1C514CA200D84B12 /* UsergridExtensions.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridExtensions.swift; sourceTree = "<group>"; };
- 63E7DD2C1C514CA200D84B12 /* UsergridKeychainHelpers.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridKeychainHelpers.swift; sourceTree = "<group>"; };
- 63E7DD2D1C514CA200D84B12 /* UsergridRequestManager.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridRequestManager.swift; sourceTree = "<group>"; };
- 63E7DD2E1C514CA200D84B12 /* UsergridSessionDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridSessionDelegate.swift; sourceTree = "<group>"; };
- 63EE60D81C404AB700AFC2CF /* UsergridResponseError.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridResponseError.swift; sourceTree = "<group>"; };
- 63EE610B1C406E1600AFC2CF /* UsergridSDK.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = UsergridSDK.framework; sourceTree = BUILT_PRODUCTS_DIR; };
- 63F36F0E1C458AAE00CEEF54 /* UsergridRequest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridRequest.swift; sourceTree = "<group>"; };
-/* End PBXFileReference section */
-
-/* Begin PBXFrameworksBuildPhase section */
- 630A219C1C49BFFC008BE87F /* Frameworks */ = {
- isa = PBXFrameworksBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 630A21A41C49BFFC008BE87F /* UsergridSDK.framework in Frameworks */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 630A21B51C49C473008BE87F /* Frameworks */ = {
- isa = PBXFrameworksBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 630A21BD1C49C473008BE87F /* UsergridSDK.framework in Frameworks */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 6319203F1C48436500F99E86 /* Frameworks */ = {
- isa = PBXFrameworksBuildPhase;
- buildActionMask = 2147483647;
- files = (
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 631920481C49BC0700F99E86 /* Frameworks */ = {
- isa = PBXFrameworksBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 631920501C49BC0700F99E86 /* UsergridSDK.framework in Frameworks */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 639B4BE71C3DD6CF005E26E7 /* Frameworks */ = {
- isa = PBXFrameworksBuildPhase;
- buildActionMask = 2147483647;
- files = (
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 63AF0E841BBC38FB009D4196 /* Frameworks */ = {
- isa = PBXFrameworksBuildPhase;
- buildActionMask = 2147483647;
- files = (
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 63EE61051C406E1600AFC2CF /* Frameworks */ = {
- isa = PBXFrameworksBuildPhase;
- buildActionMask = 2147483647;
- files = (
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXFrameworksBuildPhase section */
-
-/* Begin PBXGroup section */
- 63AF0E7E1BBC38FB009D4196 = {
- isa = PBXGroup;
- children = (
- 63AF0F3D1BBC4EF6009D4196 /* Source */,
- 63AF0F571BBC528E009D4196 /* Tests */,
- 63AF0E891BBC38FB009D4196 /* Products */,
- );
- sourceTree = "<group>";
- };
- 63AF0E891BBC38FB009D4196 /* Products */ = {
- isa = PBXGroup;
- children = (
- 63AF0E881BBC38FB009D4196 /* UsergridSDK.framework */,
- 639B4BEB1C3DD6CF005E26E7 /* UsergridSDK.framework */,
- 63EE610B1C406E1600AFC2CF /* UsergridSDK.framework */,
- 631920451C48436500F99E86 /* UsergridSDK.framework */,
- 6319204B1C49BC0700F99E86 /* UsergridSDK_TVOS_Tests.xctest */,
- 630A219F1C49BFFC008BE87F /* UsergridSDK_OSX_Tests.xctest */,
- 630A21B81C49C473008BE87F /* UsergridSDK_iOS_Tests.xctest */,
- );
- name = Products;
- sourceTree = "<group>";
- };
- 63AF0F3D1BBC4EF6009D4196 /* Source */ = {
- isa = PBXGroup;
- children = (
- 63AF0F3F1BBC4EF6009D4196 /* Usergrid.swift */,
- 63AF0F421BBC4EF6009D4196 /* UsergridClient.swift */,
- 6343823F1BC30138008624BE /* UsergridClientConfig.swift */,
- 63AF0F551BBC4F67009D4196 /* Core */,
- 63AF0F541BBC4F1F009D4196 /* Supporting Files */,
- );
- path = Source;
- sourceTree = "<group>";
- };
- 63AF0F541BBC4F1F009D4196 /* Supporting Files */ = {
- isa = PBXGroup;
- children = (
- 63AF0F471BBC4EF6009D4196 /* UsergridSDK.h */,
- 63AF0F3E1BBC4EF6009D4196 /* Info.plist */,
- );
- name = "Supporting Files";
- sourceTree = "<group>";
- };
- 63AF0F551BBC4F67009D4196 /* Core */ = {
- isa = PBXGroup;
- children = (
- 63AF0F401BBC4EF6009D4196 /* UsergridAsset.swift */,
- 63AF0F411BBC4EF6009D4196 /* UsergridAuth.swift */,
- 636A4BE11BDA8D9E0061000A /* UsergridDevice.swift */,
- 63AF0F431BBC4EF6009D4196 /* UsergridEntity.swift */,
- 6313CA2D1BD80BB9004451EE /* UsergridEnums.swift */,
- 63A7F2611BC4278200596156 /* UsergridFileMetaData.swift */,
- 63AF0F441BBC4EF6009D4196 /* UsergridQuery.swift */,
- 63AF0F461BBC4EF6009D4196 /* UsergridResponse.swift */,
- 63EE60D81C404AB700AFC2CF /* UsergridResponseError.swift */,
- 63F36F0E1C458AAE00CEEF54 /* UsergridRequest.swift */,
- 63AF0F481BBC4EF6009D4196 /* UsergridUser.swift */,
- 63E7DD431C514CA700D84B12 /* Internal */,
- );
- name = Core;
- sourceTree = "<group>";
- };
- 63AF0F571BBC528E009D4196 /* Tests */ = {
- isa = PBXGroup;
- children = (
- 63AF0F591BBC528E009D4196 /* ASSET_Tests.swift */,
- 63AF0F5A1BBC528E009D4196 /* AUTH_Tests.swift */,
- 63AF0F5B1BBC528E009D4196 /* ClientCreationTests.swift */,
- 6343823D1BC2F042008624BE /* CONNECTION_Tests.swift */,
- 63AF0F5C1BBC528E009D4196 /* Entity_Tests.swift */,
- 63AF0F5D1BBC528E009D4196 /* GET_Tests.swift */,
- 63AF0F601BBC528E009D4196 /* PUT_Tests.swift */,
- 63AF0F631BBC528E009D4196 /* User_Tests.swift */,
- 63AF0F5E1BBC528E009D4196 /* Info.plist */,
- 63AF0F7D1BBC5692009D4196 /* TestAssets */,
- );
- path = Tests;
- sourceTree = "<group>";
- };
- 63E7DD431C514CA700D84B12 /* Internal */ = {
- isa = PBXGroup;
- children = (
- 63E7DD2A1C514CA200D84B12 /* UsergridAssetRequestWrapper.swift */,
- 63E7DD2B1C514CA200D84B12 /* UsergridExtensions.swift */,
- 63E7DD2C1C514CA200D84B12 /* UsergridKeychainHelpers.swift */,
- 63E7DD2D1C514CA200D84B12 /* UsergridRequestManager.swift */,
- 63E7DD2E1C514CA200D84B12 /* UsergridSessionDelegate.swift */,
- );
- name = Internal;
- sourceTree = "<group>";
- };
-/* End PBXGroup section */
-
-/* Begin PBXHeadersBuildPhase section */
- 631920401C48436500F99E86 /* Headers */ = {
- isa = PBXHeadersBuildPhase;
- buildActionMask = 2147483647;
- files = (
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 639B4BE81C3DD6CF005E26E7 /* Headers */ = {
- isa = PBXHeadersBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 639B4BF31C3DD85A005E26E7 /* UsergridSDK.h in Headers */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 63AF0E851BBC38FB009D4196 /* Headers */ = {
- isa = PBXHeadersBuildPhase;
- buildActionMask = 2147483647;
- files = (
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 63EE61061C406E1600AFC2CF /* Headers */ = {
- isa = PBXHeadersBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 63EE610D1C406E2200AFC2CF /* UsergridSDK.h in Headers */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXHeadersBuildPhase section */
-
-/* Begin PBXNativeTarget section */
- 630A219E1C49BFFC008BE87F /* UsergridSDK_OSX_Tests */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 630A21A71C49BFFC008BE87F /* Build configuration list for PBXNativeTarget "UsergridSDK_OSX_Tests" */;
- buildPhases = (
- 630A219B1C49BFFC008BE87F /* Sources */,
- 630A219C1C49BFFC008BE87F /* Frameworks */,
- 630A219D1C49BFFC008BE87F /* Resources */,
- );
- buildRules = (
- );
- dependencies = (
- 630A21A61C49BFFC008BE87F /* PBXTargetDependency */,
- );
- name = UsergridSDK_OSX_Tests;
- productName = UsergridSDK_OSX_Tests;
- productReference = 630A219F1C49BFFC008BE87F /* UsergridSDK_OSX_Tests.xctest */;
- productType = "com.apple.product-type.bundle.unit-test";
- };
- 630A21B71C49C473008BE87F /* UsergridSDK_iOS_Tests */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 630A21C01C49C473008BE87F /* Build configuration list for PBXNativeTarget "UsergridSDK_iOS_Tests" */;
- buildPhases = (
- 630A21B41C49C473008BE87F /* Sources */,
- 630A21B51C49C473008BE87F /* Frameworks */,
- 630A21B61C49C473008BE87F /* Resources */,
- );
- buildRules = (
- );
- dependencies = (
- 630A21BF1C49C473008BE87F /* PBXTargetDependency */,
- );
- name = UsergridSDK_iOS_Tests;
- productName = UsergridSDK_iOS_Tests;
- productReference = 630A21B81C49C473008BE87F /* UsergridSDK_iOS_Tests.xctest */;
- productType = "com.apple.product-type.bundle.unit-test";
- };
- 6319202A1C48436500F99E86 /* UsergridSDK OSX */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 631920421C48436500F99E86 /* Build configuration list for PBXNativeTarget "UsergridSDK OSX" */;
- buildPhases = (
- 6319202B1C48436500F99E86 /* Sources */,
- 6319203F1C48436500F99E86 /* Frameworks */,
- 631920401C48436500F99E86 /* Headers */,
- 631920411C48436500F99E86 /* Resources */,
- );
- buildRules = (
- );
- dependencies = (
- );
- name = "UsergridSDK OSX";
- productName = UsergridSDK;
- productReference = 631920451C48436500F99E86 /* UsergridSDK.framework */;
- productType = "com.apple.product-type.framework";
- };
- 6319204A1C49BC0700F99E86 /* UsergridSDK_TVOS_Tests */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 631920531C49BC0700F99E86 /* Build configuration list for PBXNativeTarget "UsergridSDK_TVOS_Tests" */;
- buildPhases = (
- 631920471C49BC0700F99E86 /* Sources */,
- 631920481C49BC0700F99E86 /* Frameworks */,
- 631920491C49BC0700F99E86 /* Resources */,
- );
- buildRules = (
- );
- dependencies = (
- 631920521C49BC0700F99E86 /* PBXTargetDependency */,
- );
- name = UsergridSDK_TVOS_Tests;
- productName = UsergridSDK_TVOS_Tests;
- productReference = 6319204B1C49BC0700F99E86 /* UsergridSDK_TVOS_Tests.xctest */;
- productType = "com.apple.product-type.bundle.unit-test";
- };
- 639B4BEA1C3DD6CF005E26E7 /* UsergridSDK watchOS */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 639B4BF21C3DD6CF005E26E7 /* Build configuration list for PBXNativeTarget "UsergridSDK watchOS" */;
- buildPhases = (
- 639B4BE61C3DD6CF005E26E7 /* Sources */,
- 639B4BE71C3DD6CF005E26E7 /* Frameworks */,
- 639B4BE81C3DD6CF005E26E7 /* Headers */,
- 639B4BE91C3DD6CF005E26E7 /* Resources */,
- );
- buildRules = (
- );
- dependencies = (
- );
- name = "UsergridSDK watchOS";
- productName = "UsergridSDK watchOS";
- productReference = 639B4BEB1C3DD6CF005E26E7 /* UsergridSDK.framework */;
- productType = "com.apple.product-type.framework";
- };
- 63AF0E871BBC38FB009D4196 /* UsergridSDK iOS */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 63AF0E9C1BBC38FB009D4196 /* Build configuration list for PBXNativeTarget "UsergridSDK iOS" */;
- buildPhases = (
- 63AF0E831BBC38FB009D4196 /* Sources */,
- 63AF0E841BBC38FB009D4196 /* Frameworks */,
- 63AF0E851BBC38FB009D4196 /* Headers */,
- 63AF0E861BBC38FB009D4196 /* Resources */,
- );
- buildRules = (
- );
- dependencies = (
- );
- name = "UsergridSDK iOS";
- productName = UsergridSDK;
- productReference = 63AF0E881BBC38FB009D4196 /* UsergridSDK.framework */;
- productType = "com.apple.product-type.framework";
- };
- 63EE60F11C406E1600AFC2CF /* UsergridSDK tvOS */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 63EE61081C406E1600AFC2CF /* Build configuration list for PBXNativeTarget "UsergridSDK tvOS" */;
- buildPhases = (
- 63EE60F21C406E1600AFC2CF /* Sources */,
- 63EE61051C406E1600AFC2CF /* Frameworks */,
- 63EE61061C406E1600AFC2CF /* Headers */,
- 63EE61071C406E1600AFC2CF /* Resources */,
- );
- buildRules = (
- );
- dependencies = (
- );
- name = "UsergridSDK tvOS";
- productName = UsergridSDK;
- productReference = 63EE610B1C406E1600AFC2CF /* UsergridSDK.framework */;
- productType = "com.apple.product-type.framework";
- };
-/* End PBXNativeTarget section */
-
-/* Begin PBXProject section */
- 63AF0E7F1BBC38FB009D4196 /* Project object */ = {
- isa = PBXProject;
- attributes = {
- LastSwiftUpdateCheck = 0720;
- LastUpgradeCheck = 0720;
- ORGANIZATIONNAME = "Apigee Inc.";
- TargetAttributes = {
- 630A219E1C49BFFC008BE87F = {
- CreatedOnToolsVersion = 7.2;
- };
- 630A21B71C49C473008BE87F = {
- CreatedOnToolsVersion = 7.2;
- };
- 6319204A1C49BC0700F99E86 = {
- CreatedOnToolsVersion = 7.2;
- };
- 639B4BEA1C3DD6CF005E26E7 = {
- CreatedOnToolsVersion = 7.2;
- };
- 63AF0E871BBC38FB009D4196 = {
- CreatedOnToolsVersion = 7.0.1;
- };
- };
- };
- buildConfigurationList = 63AF0E821BBC38FB009D4196 /* Build configuration list for PBXProject "UsergridSDK" */;
- compatibilityVersion = "Xcode 3.2";
- developmentRegion = English;
- hasScannedForEncodings = 0;
- knownRegions = (
- en,
- );
- mainGroup = 63AF0E7E1BBC38FB009D4196;
- productRefGroup = 63AF0E891BBC38FB009D4196 /* Products */;
- projectDirPath = "";
- projectRoot = "";
- targets = (
- 63AF0E871BBC38FB009D4196 /* UsergridSDK iOS */,
- 639B4BEA1C3DD6CF005E26E7 /* UsergridSDK watchOS */,
- 63EE60F11C406E1600AFC2CF /* UsergridSDK tvOS */,
- 6319202A1C48436500F99E86 /* UsergridSDK OSX */,
- 6319204A1C49BC0700F99E86 /* UsergridSDK_TVOS_Tests */,
- 630A219E1C49BFFC008BE87F /* UsergridSDK_OSX_Tests */,
- 630A21B71C49C473008BE87F /* UsergridSDK_iOS_Tests */,
- );
- };
-/* End PBXProject section */
-
-/* Begin PBXResourcesBuildPhase section */
- 630A219D1C49BFFC008BE87F /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 630A21B31C49C013008BE87F /* TestAssets in Resources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 630A21B61C49C473008BE87F /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 630A21CD1C49C4CC008BE87F /* TestAssets in Resources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 631920411C48436500F99E86 /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 631920491C49BC0700F99E86 /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 630A219A1C49BF13008BE87F /* TestAssets in Resources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 639B4BE91C3DD6CF005E26E7 /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 63AF0E861BBC38FB009D4196 /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 63EE61071C406E1600AFC2CF /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXResourcesBuildPhase section */
-
-/* Begin PBXSourcesBuildPhase section */
- 630A219B1C49BFFC008BE87F /* Sources */ = {
- isa = PBXSourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 630A21AE1C49C011008BE87F /* Entity_Tests.swift in Sources */,
- 630A21AB1C49C011008BE87F /* AUTH_Tests.swift in Sources */,
- 630A21B21C49C011008BE87F /* User_Tests.swift in Sources */,
- 630A21B11C49C011008BE87F /* PUT_Tests.swift in Sources */,
- 630A21AD1C49C011008BE87F /* CONNECTION_Tests.swift in Sources */,
- 630A21AF1C49C011008BE87F /* GET_Tests.swift in Sources */,
- 630A21AC1C49C011008BE87F /* ClientCreationTests.swift in Sources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 630A21B41C49C473008BE87F /* Sources */ = {
- isa = PBXSourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 630A21C91C49C4C0008BE87F /* GET_Tests.swift in Sources */,
- 630A21C81C49C4C0008BE87F /* Entity_Tests.swift in Sources */,
- 630A21C61C49C4C0008BE87F /* ClientCreationTests.swift in Sources */,
- 630A21C41C49C4C0008BE87F /* ASSET_Tests.swift in Sources */,
- 630A21CC1C49C4C0008BE87F /* User_Tests.swift in Sources */,
- 630A21CB1C49C4C0008BE87F /* PUT_Tests.swift in Sources */,
- 630A21C51C49C4C0008BE87F /* AUTH_Tests.swift in Sources */,
- 630A21C71C49C4C0008BE87F /* CONNECTION_Tests.swift in Sources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 6319202B1C48436500F99E86 /* Sources */ = {
- isa = PBXSourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 6319202C1C48436500F99E86 /* UsergridResponseError.swift in Sources */,
- 6319202D1C48436500F99E86 /* UsergridRequest.swift in Sources */,
- 6319202E1C48436500F99E86 /* UsergridClientConfig.swift in Sources */,
- 63E7DD321C514CA200D84B12 /* UsergridAssetRequestWrapper.swift in Sources */,
- 631920311C48436500F99E86 /* UsergridAuth.swift in Sources */,
- 631920321C48436500F99E86 /* UsergridFileMetaData.swift in Sources */,
- 63E7DD3A1C514CA200D84B12 /* UsergridKeychainHelpers.swift in Sources */,
- 63E7DD3E1C514CA200D84B12 /* UsergridRequestManager.swift in Sources */,
- 631920331C48436500F99E86 /* UsergridDevice.swift in Sources */,
- 631920341C48436500F99E86 /* UsergridQuery.swift in Sources */,
- 63E7DD421C514CA200D84B12 /* UsergridSessionDelegate.swift in Sources */,
- 631920361C48436500F99E86 /* UsergridEntity.swift in Sources */,
- 631920381C48436500F99E86 /* UsergridUser.swift in Sources */,
- 631920391C48436500F99E86 /* Usergrid.swift in Sources */,
- 6319203A1C48436500F99E86 /* UsergridResponse.swift in Sources */,
- 6319203C1C48436500F99E86 /* UsergridEnums.swift in Sources */,
- 6319203D1C48436500F99E86 /* UsergridAsset.swift in Sources */,
- 6319203E1C48436500F99E86 /* UsergridClient.swift in Sources */,
- 63E7DD361C514CA200D84B12 /* UsergridExtensions.swift in Sources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 631920471C49BC0700F99E86 /* Sources */ = {
- isa = PBXSourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 630A21861C49BDDE008BE87F /* Entity_Tests.swift in Sources */,
- 630A218A1C49BDDE008BE87F /* User_Tests.swift in Sources */,
- 630A21891C49BDDE008BE87F /* PUT_Tests.swift in Sources */,
- 630A21821C49BDD3008BE87F /* AUTH_Tests.swift in Sources */,
- 630A21851C49BDDE008BE87F /* CONNECTION_Tests.swift in Sources */,
- 630A21871C49BDDE008BE87F /* GET_Tests.swift in Sources */,
- 630A21831C49BDDE008BE87F /* ASSET_Tests.swift in Sources */,
- 630A21841C49BDDE008BE87F /* ClientCreationTests.swift in Sources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 639B4BE61C3DD6CF005E26E7 /* Sources */ = {
- isa = PBXSourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 63EE60DA1C404AB700AFC2CF /* UsergridResponseError.swift in Sources */,
- 63F36F101C458AAE00CEEF54 /* UsergridRequest.swift in Sources */,
- 639B4BF51C3DD915005E26E7 /* UsergridAuth.swift in Sources */,
- 639B4BF71C3DD915005E26E7 /* UsergridEntity.swift in Sources */,
- 63E7DD301C514CA200D84B12 /* UsergridAssetRequestWrapper.swift in Sources */,
- 639B4C031C3DD91A005E26E7 /* UsergridClient.swift in Sources */,
- 63E7DD381C514CA200D84B12 /* UsergridKeychainHelpers.swift in Sources */,
- 63E7DD3C1C514CA200D84B12 /* UsergridRequestManager.swift in Sources */,
- 639B4C041C3DD91A005E26E7 /* UsergridClientConfig.swift in Sources */,
- 639B4BF81C3DD915005E26E7 /* UsergridEnums.swift in Sources */,
- 63E7DD401C514CA200D84B12 /* UsergridSessionDelegate.swift in Sources */,
- 639B4BFC1C3DD915005E26E7 /* UsergridUser.swift in Sources */,
- 639B4C021C3DD91A005E26E7 /* Usergrid.swift in Sources */,
- 639B4BF61C3DD915005E26E7 /* UsergridDevice.swift in Sources */,
- 639B4BF41C3DD90D005E26E7 /* UsergridAsset.swift in Sources */,
- 639B4BFB1C3DD915005E26E7 /* UsergridResponse.swift in Sources */,
- 639B4BFA1C3DD915005E26E7 /* UsergridQuery.swift in Sources */,
- 639B4BF91C3DD915005E26E7 /* UsergridFileMetaData.swift in Sources */,
- 63E7DD341C514CA200D84B12 /* UsergridExtensions.swift in Sources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 63AF0E831BBC38FB009D4196 /* Sources */ = {
- isa = PBXSourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 63EE60D91C404AB700AFC2CF /* UsergridResponseError.swift in Sources */,
- 63F36F0F1C458AAE00CEEF54 /* UsergridRequest.swift in Sources */,
- 634382401BC30138008624BE /* UsergridClientConfig.swift in Sources */,
- 63E7DD2F1C514CA200D84B12 /* UsergridAssetRequestWrapper.swift in Sources */,
- 63AF0F4C1BBC4EF6009D4196 /* UsergridAuth.swift in Sources */,
- 63A7F2621BC4278200596156 /* UsergridFileMetaData.swift in Sources */,
- 63E7DD371C514CA200D84B12 /* UsergridKeychainHelpers.swift in Sources */,
- 63E7DD3B1C514CA200D84B12 /* UsergridRequestManager.swift in Sources */,
- 636A4BE21BDA8D9E0061000A /* UsergridDevice.swift in Sources */,
- 63AF0F4F1BBC4EF6009D4196 /* UsergridQuery.swift in Sources */,
- 63E7DD3F1C514CA200D84B12 /* UsergridSessionDelegate.swift in Sources */,
- 63AF0F4E1BBC4EF6009D4196 /* UsergridEntity.swift in Sources */,
- 63AF0F531BBC4EF6009D4196 /* UsergridUser.swift in Sources */,
- 63AF0F4A1BBC4EF6009D4196 /* Usergrid.swift in Sources */,
- 63AF0F511BBC4EF6009D4196 /* UsergridResponse.swift in Sources */,
- 6313CA2E1BD80BB9004451EE /* UsergridEnums.swift in Sources */,
- 63AF0F4B1BBC4EF6009D4196 /* UsergridAsset.swift in Sources */,
- 63AF0F4D1BBC4EF6009D4196 /* UsergridClient.swift in Sources */,
- 63E7DD331C514CA200D84B12 /* UsergridExtensions.swift in Sources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 63EE60F21C406E1600AFC2CF /* Sources */ = {
- isa = PBXSourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 63EE60F31C406E1600AFC2CF /* UsergridResponseError.swift in Sources */,
- 63F36F111C458AAE00CEEF54 /* UsergridRequest.swift in Sources */,
- 63EE60F41C406E1600AFC2CF /* UsergridClientConfig.swift in Sources */,
- 63E7DD311C514CA200D84B12 /* UsergridAssetRequestWrapper.swift in Sources */,
- 63EE60F71C406E1600AFC2CF /* UsergridAuth.swift in Sources */,
- 63EE60F81C406E1600AFC2CF /* UsergridFileMetaData.swift in Sources */,
- 63E7DD391C514CA200D84B12 /* UsergridKeychainHelpers.swift in Sources */,
- 63E7DD3D1C514CA200D84B12 /* UsergridRequestManager.swift in Sources */,
- 63EE60F91C406E1600AFC2CF /* UsergridDevice.swift in Sources */,
- 63EE60FA1C406E1600AFC2CF /* UsergridQuery.swift in Sources */,
- 63E7DD411C514CA200D84B12 /* UsergridSessionDelegate.swift in Sources */,
- 63EE60FC1C406E1600AFC2CF /* UsergridEntity.swift in Sources */,
- 63EE60FE1C406E1600AFC2CF /* UsergridUser.swift in Sources */,
- 63EE60FF1C406E1600AFC2CF /* Usergrid.swift in Sources */,
- 63EE61001C406E1600AFC2CF /* UsergridResponse.swift in Sources */,
- 63EE61021C406E1600AFC2CF /* UsergridEnums.swift in Sources */,
- 63EE61031C406E1600AFC2CF /* UsergridAsset.swift in Sources */,
- 63EE61041C406E1600AFC2CF /* UsergridClient.swift in Sources */,
- 63E7DD351C514CA200D84B12 /* UsergridExtensions.swift in Sources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXSourcesBuildPhase section */
-
-/* Begin PBXTargetDependency section */
- 630A21A61C49BFFC008BE87F /* PBXTargetDependency */ = {
- isa = PBXTargetDependency;
- target = 6319202A1C48436500F99E86 /* UsergridSDK OSX */;
- targetProxy = 630A21A51C49BFFC008BE87F /* PBXContainerItemProxy */;
- };
- 630A21BF1C49C473008BE87F /* PBXTargetDependency */ = {
- isa = PBXTargetDependency;
- target = 63AF0E871BBC38FB009D4196 /* UsergridSDK iOS */;
- targetProxy = 630A21BE1C49C473008BE87F /* PBXContainerItemProxy */;
- };
- 631920521C49BC0700F99E86 /* PBXTargetDependency */ = {
- isa = PBXTargetDependency;
- target = 63EE60F11C406E1600AFC2CF /* UsergridSDK tvOS */;
- targetProxy = 631920511C49BC0700F99E86 /* PBXContainerItemProxy */;
- };
-/* End PBXTargetDependency section */
-
-/* Begin XCBuildConfiguration section */
- 630A21A81C49BFFC008BE87F /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- CODE_SIGN_IDENTITY = "-";
- COMBINE_HIDPI_IMAGES = YES;
- INFOPLIST_FILE = Tests/Info.plist;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks @loader_path/../Frameworks";
- MACOSX_DEPLOYMENT_TARGET = 10.11;
- PRODUCT_BUNDLE_IDENTIFIER = "org.apache.usergrid.swift-OSX-Tests";
- PRODUCT_NAME = "$(TARGET_NAME)";
- SDKROOT = macosx;
- };
- name = Debug;
- };
- 630A21A91C49BFFC008BE87F /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- CODE_SIGN_IDENTITY = "-";
- COMBINE_HIDPI_IMAGES = YES;
- INFOPLIST_FILE = Tests/Info.plist;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks @loader_path/../Frameworks";
- MACOSX_DEPLOYMENT_TARGET = 10.11;
- PRODUCT_BUNDLE_IDENTIFIER = "org.apache.usergrid.swift-OSX-Tests";
- PRODUCT_NAME = "$(TARGET_NAME)";
- SDKROOT = macosx;
- };
- name = Release;
- };
- 630A21C11C49C473008BE87F /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- INFOPLIST_FILE = Tests/Info.plist;
- IPHONEOS_DEPLOYMENT_TARGET = 9.2;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = "org.apache.usergrid.swift-iOS-Tests";
- PRODUCT_NAME = "$(TARGET_NAME)";
- };
- name = Debug;
- };
- 630A21C21C49C473008BE87F /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- INFOPLIST_FILE = Tests/Info.plist;
- IPHONEOS_DEPLOYMENT_TARGET = 9.2;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = "org.apache.usergrid.swift-iOS-Tests";
- PRODUCT_NAME = "$(TARGET_NAME)";
- };
- name = Release;
- };
- 631920431C48436500F99E86 /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- CLANG_ENABLE_MODULES = YES;
- CODE_SIGN_IDENTITY = "";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "";
- COMBINE_HIDPI_IMAGES = YES;
- DEFINES_MODULE = YES;
- DYLIB_COMPATIBILITY_VERSION = 1;
- DYLIB_CURRENT_VERSION = 1;
- DYLIB_INSTALL_NAME_BASE = "@rpath";
- INFOPLIST_FILE = Source/Info.plist;
- INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
- IPHONEOS_DEPLOYMENT_TARGET = 8.0;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = org.apache.usergrid.swift;
- PRODUCT_NAME = UsergridSDK;
- SDKROOT = macosx;
- SKIP_INSTALL = YES;
- SWIFT_OPTIMIZATION_LEVEL = "-Onone";
- };
- name = Debug;
- };
- 631920441C48436500F99E86 /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- CLANG_ENABLE_MODULES = YES;
- CODE_SIGN_IDENTITY = "";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "";
- COMBINE_HIDPI_IMAGES = YES;
- DEFINES_MODULE = YES;
- DYLIB_COMPATIBILITY_VERSION = 1;
- DYLIB_CURRENT_VERSION = 1;
- DYLIB_INSTALL_NAME_BASE = "@rpath";
- INFOPLIST_FILE = Source/Info.plist;
- INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
- IPHONEOS_DEPLOYMENT_TARGET = 8.0;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = org.apache.usergrid.swift;
- PRODUCT_NAME = UsergridSDK;
- SDKROOT = macosx;
- SKIP_INSTALL = YES;
- };
- name = Release;
- };
- 631920541C49BC0700F99E86 /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- INFOPLIST_FILE = Tests/Info.plist;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = "org.apache.usergrid.swift-TVOS-Tests";
- PRODUCT_NAME = "$(TARGET_NAME)";
- SDKROOT = appletvos;
- TARGETED_DEVICE_FAMILY = 3;
- TVOS_DEPLOYMENT_TARGET = 9.2;
- };
- name = Debug;
- };
- 631920551C49BC0700F99E86 /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- INFOPLIST_FILE = Tests/Info.plist;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = "org.apache.usergrid.swift-TVOS-Tests";
- PRODUCT_NAME = "$(TARGET_NAME)";
- SDKROOT = appletvos;
- TARGETED_DEVICE_FAMILY = 3;
- TVOS_DEPLOYMENT_TARGET = 9.2;
- };
- name = Release;
- };
- 639B4BF01C3DD6CF005E26E7 /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- APPLICATION_EXTENSION_API_ONLY = YES;
- DEFINES_MODULE = YES;
- DYLIB_COMPATIBILITY_VERSION = 1;
- DYLIB_CURRENT_VERSION = 1;
- DYLIB_INSTALL_NAME_BASE = "@rpath";
- INFOPLIST_FILE = Source/Info.plist;
- INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = org.apache.usergrid.swift;
- PRODUCT_NAME = UsergridSDK;
- SDKROOT = watchos;
- SKIP_INSTALL = YES;
- TARGETED_DEVICE_FAMILY = 4;
- WATCHOS_DEPLOYMENT_TARGET = 2.1;
- };
- name = Debug;
- };
- 639B4BF11C3DD6CF005E26E7 /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- APPLICATION_EXTENSION_API_ONLY = YES;
- DEFINES_MODULE = YES;
- DYLIB_COMPATIBILITY_VERSION = 1;
- DYLIB_CURRENT_VERSION = 1;
- DYLIB_INSTALL_NAME_BASE = "@rpath";
- INFOPLIST_FILE = Source/Info.plist;
- INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = org.apache.usergrid.swift;
- PRODUCT_NAME = UsergridSDK;
- SDKROOT = watchos;
- SKIP_INSTALL = YES;
- TARGETED_DEVICE_FAMILY = 4;
- WATCHOS_DEPLOYMENT_TARGET = 2.1;
- };
- name = Release;
- };
- 63AF0E9A1BBC38FB009D4196 /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ALWAYS_SEARCH_USER_PATHS = NO;
- CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
- CLANG_CXX_LIBRARY = "libc++";
- CLANG_ENABLE_MODULES = YES;
- CLANG_ENABLE_OBJC_ARC = YES;
- CLANG_WARN_BOOL_CONVERSION = YES;
- CLANG_WARN_CONSTANT_CONVERSION = YES;
- CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
- CLANG_WARN_EMPTY_BODY = YES;
- CLANG_WARN_ENUM_CONVERSION = YES;
- CLANG_WARN_INT_CONVERSION = YES;
- CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
- CLANG_WARN_UNREACHABLE_CODE = YES;
- CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- COPY_PHASE_STRIP = NO;
- CURRENT_PROJECT_VERSION = 1;
- DEBUG_INFORMATION_FORMAT = dwarf;
- ENABLE_STRICT_OBJC_MSGSEND = YES;
- ENABLE_TESTABILITY = YES;
- GCC_C_LANGUAGE_STANDARD = gnu99;
- GCC_DYNAMIC_NO_PIC = NO;
- GCC_NO_COMMON_BLOCKS = YES;
- GCC_OPTIMIZATION_LEVEL = 0;
- GCC_PREPROCESSOR_DEFINITIONS = (
- "DEBUG=1",
- "$(inherited)",
- );
- GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
- GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
- GCC_WARN_UNDECLARED_SELECTOR = YES;
- GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
- GCC_WARN_UNUSED_FUNCTION = YES;
- GCC_WARN_UNUSED_VARIABLE = YES;
- IPHONEOS_DEPLOYMENT_TARGET = 9.0;
- MTL_ENABLE_DEBUG_INFO = YES;
- ONLY_ACTIVE_ARCH = YES;
- SDKROOT = iphoneos;
- SWIFT_OPTIMIZATION_LEVEL = "-Onone";
- TARGETED_DEVICE_FAMILY = "1,2";
- VERSIONING_SYSTEM = "apple-generic";
- VERSION_INFO_PREFIX = "";
- };
- name = Debug;
- };
- 63AF0E9B1BBC38FB009D4196 /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ALWAYS_SEARCH_USER_PATHS = NO;
- CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
- CLANG_CXX_LIBRARY = "libc++";
- CLANG_ENABLE_MODULES = YES;
- CLANG_ENABLE_OBJC_ARC = YES;
- CLANG_WARN_BOOL_CONVERSION = YES;
- CLANG_WARN_CONSTANT_CONVERSION = YES;
- CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
- CLANG_WARN_EMPTY_BODY = YES;
- CLANG_WARN_ENUM_CONVERSION = YES;
- CLANG_WARN_INT_CONVERSION = YES;
- CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
- CLANG_WARN_UNREACHABLE_CODE = YES;
- CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- COPY_PHASE_STRIP = NO;
- CURRENT_PROJECT_VERSION = 1;
- DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
- ENABLE_NS_ASSERTIONS = NO;
- ENABLE_STRICT_OBJC_MSGSEND = YES;
- GCC_C_LANGUAGE_STANDARD = gnu99;
- GCC_NO_COMMON_BLOCKS = YES;
- GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
- GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
- GCC_WARN_UNDECLARED_SELECTOR = YES;
- GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
- GCC_WARN_UNUSED_FUNCTION = YES;
- GCC_WARN_UNUSED_VARIABLE = YES;
- IPHONEOS_DEPLOYMENT_TARGET = 9.0;
- MTL_ENABLE_DEBUG_INFO = NO;
- SDKROOT = iphoneos;
- TARGETED_DEVICE_FAMILY = "1,2";
- VALIDATE_PRODUCT = YES;
- VERSIONING_SYSTEM = "apple-generic";
- VERSION_INFO_PREFIX = "";
- };
- name = Release;
- };
- 63AF0E9D1BBC38FB009D4196 /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- CLANG_ENABLE_MODULES = YES;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- DEFINES_MODULE = YES;
- DYLIB_COMPATIBILITY_VERSION = 1;
- DYLIB_CURRENT_VERSION = 1;
- DYLIB_INSTALL_NAME_BASE = "@rpath";
- INFOPLIST_FILE = Source/Info.plist;
- INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
- IPHONEOS_DEPLOYMENT_TARGET = 8.0;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = org.apache.usergrid.swift;
- PRODUCT_NAME = UsergridSDK;
- SKIP_INSTALL = YES;
- SWIFT_OPTIMIZATION_LEVEL = "-Onone";
- };
- name = Debug;
- };
- 63AF0E9E1BBC38FB009D4196 /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- CLANG_ENABLE_MODULES = YES;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- DEFINES_MODULE = YES;
- DYLIB_COMPATIBILITY_VERSION = 1;
- DYLIB_CURRENT_VERSION = 1;
- DYLIB_INSTALL_NAME_BASE = "@rpath";
- INFOPLIST_FILE = Source/Info.plist;
- INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
- IPHONEOS_DEPLOYMENT_TARGET = 8.0;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = org.apache.usergrid.swift;
- PRODUCT_NAME = UsergridSDK;
- SKIP_INSTALL = YES;
- };
- name = Release;
- };
- 63EE61091C406E1600AFC2CF /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- CLANG_ENABLE_MODULES = YES;
- DEFINES_MODULE = YES;
- DYLIB_COMPATIBILITY_VERSION = 1;
- DYLIB_CURRENT_VERSION = 1;
- DYLIB_INSTALL_NAME_BASE = "@rpath";
- INFOPLIST_FILE = Source/Info.plist;
- INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
- IPHONEOS_DEPLOYMENT_TARGET = 8.0;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = org.apache.usergrid.swift;
- PRODUCT_NAME = UsergridSDK;
- SDKROOT = appletvos;
- SKIP_INSTALL = YES;
- SWIFT_OPTIMIZATION_LEVEL = "-Onone";
- TARGETED_DEVICE_FAMILY = 3;
- };
- name = Debug;
- };
- 63EE610A1C406E1600AFC2CF /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- CLANG_ENABLE_MODULES = YES;
- DEFINES_MODULE = YES;
- DYLIB_COMPATIBILITY_VERSION = 1;
- DYLIB_CURRENT_VERSION = 1;
- DYLIB_INSTALL_NAME_BASE = "@rpath";
- INFOPLIST_FILE = Source/Info.plist;
- INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
- IPHONEOS_DEPLOYMENT_TARGET = 8.0;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = org.apache.usergrid.swift;
- PRODUCT_NAME = UsergridSDK;
- SDKROOT = appletvos;
- SKIP_INSTALL = YES;
- TARGETED_DEVICE_FAMILY = 3;
- };
- name = Release;
- };
-/* End XCBuildConfiguration section */
-
-/* Begin XCConfigurationList section */
- 630A21A71C49BFFC008BE87F /* Build configuration list for PBXNativeTarget "UsergridSDK_OSX_Tests" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 630A21A81C49BFFC008BE87F /* Debug */,
- 630A21A91C49BFFC008BE87F /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 630A21C01C49C473008BE87F /* Build configuration list for PBXNativeTarget "UsergridSDK_iOS_Tests" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 630A21C11C49C473008BE87F /* Debug */,
- 630A21C21C49C473008BE87F /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 631920421C48436500F99E86 /* Build configuration list for PBXNativeTarget "UsergridSDK OSX" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 631920431C48436500F99E86 /* Debug */,
- 631920441C48436500F99E86 /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 631920531C49BC0700F99E86 /* Build configuration list for PBXNativeTarget "UsergridSDK_TVOS_Tests" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 631920541C49BC0700F99E86 /* Debug */,
- 631920551C49BC0700F99E86 /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 639B4BF21C3DD6CF005E26E7 /* Build configuration list for PBXNativeTarget "UsergridSDK watchOS" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 639B4BF01C3DD6CF005E26E7 /* Debug */,
- 639B4BF11C3DD6CF005E26E7 /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 63AF0E821BBC38FB009D4196 /* Build configuration list for PBXProject "UsergridSDK" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 63AF0E9A1BBC38FB009D4196 /* Debug */,
- 63AF0E9B1BBC38FB009D4196 /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 63AF0E9C1BBC38FB009D4196 /* Build configuration list for PBXNativeTarget "UsergridSDK iOS" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 63AF0E9D1BBC38FB009D4196 /* Debug */,
- 63AF0E9E1BBC38FB009D4196 /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 63EE61081C406E1600AFC2CF /* Build configuration list for PBXNativeTarget "UsergridSDK tvOS" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 63EE61091C406E1600AFC2CF /* Debug */,
- 63EE610A1C406E1600AFC2CF /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
-/* End XCConfigurationList section */
- };
- rootObject = 63AF0E7F1BBC38FB009D4196 /* Project object */;
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/UsergridSDK.xcodeproj/project.xcworkspace/contents.xcworkspacedata
----------------------------------------------------------------------
diff --git a/sdks/swift/UsergridSDK.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/sdks/swift/UsergridSDK.xcodeproj/project.xcworkspace/contents.xcworkspacedata
deleted file mode 100644
index f50005a..0000000
--- a/sdks/swift/UsergridSDK.xcodeproj/project.xcworkspace/contents.xcworkspacedata
+++ /dev/null
@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
- version = "1.0">
- <FileRef
- location = "self:UsergridSDK.xcodeproj">
- </FileRef>
-</Workspace>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/UsergridSDK.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings
----------------------------------------------------------------------
diff --git a/sdks/swift/UsergridSDK.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/sdks/swift/UsergridSDK.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings
deleted file mode 100644
index 08de0be..0000000
--- a/sdks/swift/UsergridSDK.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings
+++ /dev/null
@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
- <key>IDEWorkspaceSharedSettings_AutocreateContextsIfNeeded</key>
- <false/>
-</dict>
-</plist>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK OSX.xcscheme
----------------------------------------------------------------------
diff --git a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK OSX.xcscheme b/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK OSX.xcscheme
deleted file mode 100644
index 591624c..0000000
--- a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK OSX.xcscheme
+++ /dev/null
@@ -1,100 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
- LastUpgradeVersion = "0720"
- version = "1.3">
- <BuildAction
- parallelizeBuildables = "YES"
- buildImplicitDependencies = "YES">
- <BuildActionEntries>
- <BuildActionEntry
- buildForTesting = "YES"
- buildForRunning = "YES"
- buildForProfiling = "YES"
- buildForArchiving = "YES"
- buildForAnalyzing = "YES">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "6319202A1C48436500F99E86"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK OSX"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </BuildActionEntry>
- </BuildActionEntries>
- </BuildAction>
- <TestAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- shouldUseLaunchSchemeArgsEnv = "YES"
- codeCoverageEnabled = "YES">
- <Testables>
- <TestableReference
- skipped = "NO">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "630A219E1C49BFFC008BE87F"
- BuildableName = "UsergridSDK_OSX_Tests.xctest"
- BlueprintName = "UsergridSDK_OSX_Tests"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </TestableReference>
- </Testables>
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "6319202A1C48436500F99E86"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK OSX"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- <AdditionalOptions>
- </AdditionalOptions>
- </TestAction>
- <LaunchAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- launchStyle = "0"
- useCustomWorkingDirectory = "NO"
- ignoresPersistentStateOnLaunch = "NO"
- debugDocumentVersioning = "YES"
- debugServiceExtension = "internal"
- allowLocationSimulation = "YES">
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "6319202A1C48436500F99E86"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK OSX"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- <AdditionalOptions>
- </AdditionalOptions>
- </LaunchAction>
- <ProfileAction
- buildConfiguration = "Release"
- shouldUseLaunchSchemeArgsEnv = "YES"
- savedToolIdentifier = ""
- useCustomWorkingDirectory = "NO"
- debugDocumentVersioning = "YES">
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "6319202A1C48436500F99E86"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK OSX"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- </ProfileAction>
- <AnalyzeAction
- buildConfiguration = "Debug">
- </AnalyzeAction>
- <ArchiveAction
- buildConfiguration = "Release"
- revealArchiveInOrganizer = "YES">
- </ArchiveAction>
-</Scheme>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK iOS.xcscheme
----------------------------------------------------------------------
diff --git a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK iOS.xcscheme b/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK iOS.xcscheme
deleted file mode 100644
index 2c81a49..0000000
--- a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK iOS.xcscheme
+++ /dev/null
@@ -1,100 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
- LastUpgradeVersion = "0720"
- version = "1.3">
- <BuildAction
- parallelizeBuildables = "YES"
- buildImplicitDependencies = "YES">
- <BuildActionEntries>
- <BuildActionEntry
- buildForTesting = "YES"
- buildForRunning = "YES"
- buildForProfiling = "YES"
- buildForArchiving = "YES"
- buildForAnalyzing = "YES">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "63AF0E871BBC38FB009D4196"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK iOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </BuildActionEntry>
- </BuildActionEntries>
- </BuildAction>
- <TestAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- shouldUseLaunchSchemeArgsEnv = "YES"
- codeCoverageEnabled = "YES">
- <Testables>
- <TestableReference
- skipped = "NO">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "630A21B71C49C473008BE87F"
- BuildableName = "UsergridSDK_iOS_Tests.xctest"
- BlueprintName = "UsergridSDK_iOS_Tests"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </TestableReference>
- </Testables>
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "63AF0E871BBC38FB009D4196"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK iOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- <AdditionalOptions>
- </AdditionalOptions>
- </TestAction>
- <LaunchAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- launchStyle = "0"
- useCustomWorkingDirectory = "NO"
- ignoresPersistentStateOnLaunch = "NO"
- debugDocumentVersioning = "YES"
- debugServiceExtension = "internal"
- allowLocationSimulation = "YES">
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "63AF0E871BBC38FB009D4196"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK iOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- <AdditionalOptions>
- </AdditionalOptions>
- </LaunchAction>
- <ProfileAction
- buildConfiguration = "Release"
- shouldUseLaunchSchemeArgsEnv = "YES"
- savedToolIdentifier = ""
- useCustomWorkingDirectory = "NO"
- debugDocumentVersioning = "YES">
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "63AF0E871BBC38FB009D4196"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK iOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- </ProfileAction>
- <AnalyzeAction
- buildConfiguration = "Debug">
- </AnalyzeAction>
- <ArchiveAction
- buildConfiguration = "Release"
- revealArchiveInOrganizer = "YES">
- </ArchiveAction>
-</Scheme>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK tvOS.xcscheme
----------------------------------------------------------------------
diff --git a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK tvOS.xcscheme b/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK tvOS.xcscheme
deleted file mode 100644
index 0c2ae38..0000000
--- a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK tvOS.xcscheme
+++ /dev/null
@@ -1,114 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
- LastUpgradeVersion = "0720"
- version = "1.3">
- <BuildAction
- parallelizeBuildables = "YES"
- buildImplicitDependencies = "YES">
- <BuildActionEntries>
- <BuildActionEntry
- buildForTesting = "YES"
- buildForRunning = "YES"
- buildForProfiling = "YES"
- buildForArchiving = "YES"
- buildForAnalyzing = "YES">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "63EE60F11C406E1600AFC2CF"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK tvOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </BuildActionEntry>
- <BuildActionEntry
- buildForTesting = "YES"
- buildForRunning = "NO"
- buildForProfiling = "NO"
- buildForArchiving = "NO"
- buildForAnalyzing = "NO">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "6319204A1C49BC0700F99E86"
- BuildableName = "UsergridSDK_TVOS_Tests.xctest"
- BlueprintName = "UsergridSDK_TVOS_Tests"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </BuildActionEntry>
- </BuildActionEntries>
- </BuildAction>
- <TestAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- shouldUseLaunchSchemeArgsEnv = "YES"
- codeCoverageEnabled = "YES">
- <Testables>
- <TestableReference
- skipped = "NO">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "6319204A1C49BC0700F99E86"
- BuildableName = "UsergridSDK_TVOS_Tests.xctest"
- BlueprintName = "UsergridSDK_TVOS_Tests"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </TestableReference>
- </Testables>
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "63EE60F11C406E1600AFC2CF"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK tvOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- <AdditionalOptions>
- </AdditionalOptions>
- </TestAction>
- <LaunchAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- launchStyle = "0"
- useCustomWorkingDirectory = "NO"
- ignoresPersistentStateOnLaunch = "NO"
- debugDocumentVersioning = "YES"
- debugServiceExtension = "internal"
- allowLocationSimulation = "YES">
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "63EE60F11C406E1600AFC2CF"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK tvOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- <AdditionalOptions>
- </AdditionalOptions>
- </LaunchAction>
- <ProfileAction
- buildConfiguration = "Release"
- shouldUseLaunchSchemeArgsEnv = "YES"
- savedToolIdentifier = ""
- useCustomWorkingDirectory = "NO"
- debugDocumentVersioning = "YES">
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "63EE60F11C406E1600AFC2CF"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK tvOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- </ProfileAction>
- <AnalyzeAction
- buildConfiguration = "Debug">
- </AnalyzeAction>
- <ArchiveAction
- buildConfiguration = "Release"
- revealArchiveInOrganizer = "YES">
- </ArchiveAction>
-</Scheme>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK watchOS.xcscheme
----------------------------------------------------------------------
diff --git a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK watchOS.xcscheme b/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK watchOS.xcscheme
deleted file mode 100644
index 7ba8b2a..0000000
--- a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK watchOS.xcscheme
+++ /dev/null
@@ -1,80 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
- LastUpgradeVersion = "0720"
- version = "1.3">
- <BuildAction
- parallelizeBuildables = "YES"
- buildImplicitDependencies = "YES">
- <BuildActionEntries>
- <BuildActionEntry
- buildForTesting = "YES"
- buildForRunning = "YES"
- buildForProfiling = "YES"
- buildForArchiving = "YES"
- buildForAnalyzing = "YES">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "639B4BEA1C3DD6CF005E26E7"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK watchOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </BuildActionEntry>
- </BuildActionEntries>
- </BuildAction>
- <TestAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- shouldUseLaunchSchemeArgsEnv = "YES">
- <Testables>
- </Testables>
- <AdditionalOptions>
- </AdditionalOptions>
- </TestAction>
- <LaunchAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- launchStyle = "0"
- useCustomWorkingDirectory = "NO"
- ignoresPersistentStateOnLaunch = "NO"
- debugDocumentVersioning = "YES"
- debugServiceExtension = "internal"
- allowLocationSimulation = "YES">
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "639B4BEA1C3DD6CF005E26E7"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK watchOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- <AdditionalOptions>
- </AdditionalOptions>
- </LaunchAction>
- <ProfileAction
- buildConfiguration = "Release"
- shouldUseLaunchSchemeArgsEnv = "YES"
- savedToolIdentifier = ""
- useCustomWorkingDirectory = "NO"
- debugDocumentVersioning = "YES">
- <MacroExpansion>
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "639B4BEA1C3DD6CF005E26E7"
- BuildableName = "UsergridSDK.framework"
- BlueprintName = "UsergridSDK watchOS"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </MacroExpansion>
- </ProfileAction>
- <AnalyzeAction
- buildConfiguration = "Debug">
- </AnalyzeAction>
- <ArchiveAction
- buildConfiguration = "Release"
- revealArchiveInOrganizer = "YES">
- </ArchiveAction>
-</Scheme>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_OSX_Tests.xcscheme
----------------------------------------------------------------------
diff --git a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_OSX_Tests.xcscheme b/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_OSX_Tests.xcscheme
deleted file mode 100644
index 4e01ef0..0000000
--- a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_OSX_Tests.xcscheme
+++ /dev/null
@@ -1,56 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
- LastUpgradeVersion = "0720"
- version = "1.3">
- <BuildAction
- parallelizeBuildables = "YES"
- buildImplicitDependencies = "YES">
- </BuildAction>
- <TestAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- shouldUseLaunchSchemeArgsEnv = "YES">
- <Testables>
- <TestableReference
- skipped = "NO">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "630A219E1C49BFFC008BE87F"
- BuildableName = "UsergridSDK_OSX_Tests.xctest"
- BlueprintName = "UsergridSDK_OSX_Tests"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </TestableReference>
- </Testables>
- <AdditionalOptions>
- </AdditionalOptions>
- </TestAction>
- <LaunchAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- launchStyle = "0"
- useCustomWorkingDirectory = "NO"
- ignoresPersistentStateOnLaunch = "NO"
- debugDocumentVersioning = "YES"
- debugServiceExtension = "internal"
- allowLocationSimulation = "YES">
- <AdditionalOptions>
- </AdditionalOptions>
- </LaunchAction>
- <ProfileAction
- buildConfiguration = "Release"
- shouldUseLaunchSchemeArgsEnv = "YES"
- savedToolIdentifier = ""
- useCustomWorkingDirectory = "NO"
- debugDocumentVersioning = "YES">
- </ProfileAction>
- <AnalyzeAction
- buildConfiguration = "Debug">
- </AnalyzeAction>
- <ArchiveAction
- buildConfiguration = "Release"
- revealArchiveInOrganizer = "YES">
- </ArchiveAction>
-</Scheme>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_TVOS_Tests.xcscheme
----------------------------------------------------------------------
diff --git a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_TVOS_Tests.xcscheme b/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_TVOS_Tests.xcscheme
deleted file mode 100644
index bae88d1..0000000
--- a/sdks/swift/UsergridSDK.xcodeproj/xcshareddata/xcschemes/UsergridSDK_TVOS_Tests.xcscheme
+++ /dev/null
@@ -1,56 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
- LastUpgradeVersion = "0720"
- version = "1.3">
- <BuildAction
- parallelizeBuildables = "YES"
- buildImplicitDependencies = "YES">
- </BuildAction>
- <TestAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- shouldUseLaunchSchemeArgsEnv = "YES">
- <Testables>
- <TestableReference
- skipped = "NO">
- <BuildableReference
- BuildableIdentifier = "primary"
- BlueprintIdentifier = "6319204A1C49BC0700F99E86"
- BuildableName = "UsergridSDK_TVOS_Tests.xctest"
- BlueprintName = "UsergridSDK_TVOS_Tests"
- ReferencedContainer = "container:UsergridSDK.xcodeproj">
- </BuildableReference>
- </TestableReference>
- </Testables>
- <AdditionalOptions>
- </AdditionalOptions>
- </TestAction>
- <LaunchAction
- buildConfiguration = "Debug"
- selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
- selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
- launchStyle = "0"
- useCustomWorkingDirectory = "NO"
- ignoresPersistentStateOnLaunch = "NO"
- debugDocumentVersioning = "YES"
- debugServiceExtension = "internal"
- allowLocationSimulation = "YES">
- <AdditionalOptions>
- </AdditionalOptions>
- </LaunchAction>
- <ProfileAction
- buildConfiguration = "Release"
- shouldUseLaunchSchemeArgsEnv = "YES"
- savedToolIdentifier = ""
- useCustomWorkingDirectory = "NO"
- debugDocumentVersioning = "YES">
- </ProfileAction>
- <AnalyzeAction
- buildConfiguration = "Debug">
- </AnalyzeAction>
- <ArchiveAction
- buildConfiguration = "Release"
- revealArchiveInOrganizer = "YES">
- </ArchiveAction>
-</Scheme>
[35/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridQuery.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridQuery.html b/sdks/swift/docs/Classes/UsergridQuery.html
deleted file mode 100644
index 5b8d3e5..0000000
--- a/sdks/swift/docs/Classes/UsergridQuery.html
+++ /dev/null
@@ -1,2278 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridQuery 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/UsergridQuery" class="dashAnchor"></a>
- <a title="UsergridQuery 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" />
- UsergridQuery 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>UsergridQuery</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridQuery</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span><span class="kt">NSCopying</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridQuery</code> is builder class used to construct filtered requests to Usergrid.</p>
-
-<p><code>UsergridQuery</code> objects are then passed to <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> or <code><a href="../Classes/Usergrid.html">Usergrid</a></code> methods which support <code>UsergridQuery</code> as a parameter are .GET(), .PUT(), and .DELETE().</p>
-
- </section>
- <section class="section task-group-section">
- <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:FC11UsergridSDK13UsergridQuerycFTGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuerycFTGSqSS__S0_">init(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Desingated initializer for <code><a href="../Classes/UsergridQuery.html">UsergridQuery</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="n">_</span> <span class="nv">collectionName</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>collectionName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The collection name or <code>type</code> of entities you want to query.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridQuery.html">UsergridQuery</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/NSCopying"></a>
- <a name="//apple_ref/swift/Section/NSCopying" class="dashAnchor"></a>
- <a href="#/NSCopying">
- <h3 class="section-name">NSCopying</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery12copyWithZoneFV10ObjectiveC6NSZonePs9AnyObject_"></a>
- <a name="//apple_ref/swift/Method/copyWithZone(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery12copyWithZoneFV10ObjectiveC6NSZonePs9AnyObject_">copyWithZone(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>See the NSCopying protocol.</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">copyWithZone</span><span class="p">(</span><span class="nv">zone</span><span class="p">:</span> <span class="kt">NSZone</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AnyObject</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>zone</em>
- </code>
- </td>
- <td>
- <div>
- <p>Ignored</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>Returns a new instance that\u2019s a copy of the receiver.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Building"></a>
- <a name="//apple_ref/swift/Section/Building" class="dashAnchor"></a>
- <a href="#/Building">
- <h3 class="section-name">Building</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery5buildFTSb_SS"></a>
- <a name="//apple_ref/swift/Method/build(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery5buildFTSb_SS">build(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Constructs the string that should be appeneded to the end of the URL as a query.</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">build</span><span class="p">(</span><span class="nv">autoURLEncode</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>autoURLEncode</em>
- </code>
- </td>
- <td>
- <div>
- <p>Automatically encode the constructed string.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The constructed URL query sting.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Builder%20Methods"></a>
- <a name="//apple_ref/swift/Section/Builder Methods" class="dashAnchor"></a>
- <a href="#/Builder%20Methods">
- <h3 class="section-name">Builder Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery8containsFTSS5valueSS_DS0_"></a>
- <a name="//apple_ref/swift/Method/contains(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery8containsFTSS5valueSS_DS0_">contains(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Contains. Query: where term contains ‘val%’.</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">contains</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">containsWord</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery14containsStringFTSS5valueSS_DS0_"></a>
- <a name="//apple_ref/swift/Method/containsString(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery14containsStringFTSS5valueSS_DS0_">containsString(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Contains. Query: where term contains ‘val%’.</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">containsString</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">containsWord</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery12containsWordFTSS5valueSS_DS0_"></a>
- <a name="//apple_ref/swift/Method/containsWord(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery12containsWordFTSS5valueSS_DS0_">containsWord(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Contains. Query: where term contains ‘val%’.</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">containsWord</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addRequirement</span><span class="p">(</span><span class="n">term</span> <span class="o">+</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">SPACE</span> <span class="o">+</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">CONTAINS</span> <span class="o">+</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">SPACE</span> <
span class="o">+</span> <span class="p">((</span><span class="n">value</span><span class="o">.</span><span class="nf">isUuid</span><span class="p">())</span> <span class="p">?</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">EMPTY_STRING</span> <span class="p">:</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">APOSTROPHE</span><span class="p">)</span> <span class="o">+</span> <span class="n">value</span> <span class="o">+</span> <span class="p">((</span><span class="n">value</span><span class="o">.</span><span class="nf">isUuid</span><span class="p">())</span> <span class="p">?</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">EMPTY_STRING</span> <span class="p">:</span> <span class="kt">UsergridQuery</span><span class="o">.</span><span class="kt">APOSTROPHE</span><span class="p">))</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery9ascendingFSSDS0_"></a>
- <a name="//apple_ref/swift/Method/ascending(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery9ascendingFSSDS0_">ascending(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort ascending. Query:. order by term asc.</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">ascending</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">asc</span><span class="p">(</span><span class="n">term</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery3ascFSSDS0_"></a>
- <a name="//apple_ref/swift/Method/asc(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3ascFSSDS0_">asc(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort ascending. Query:. order by term asc.</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">asc</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">sort</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">sortOrder</span><span class="p">:</span> <span class="o">.</span><span class="kt">Asc</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery10descendingFSSDS0_"></a>
- <a name="//apple_ref/swift/Method/descending(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery10descendingFSSDS0_">descending(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort descending. Query: order by term desc</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">descending</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">desc</span><span class="p">(</span><span class="n">term</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery4descFSSDS0_"></a>
- <a name="//apple_ref/swift/Method/desc(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery4descFSSDS0_">desc(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort descending. Query: order by term desc</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">desc</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">sort</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">sortOrder</span><span class="p">:</span> <span class="o">.</span><span class="kt">Desc</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery6filterFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/filter(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery6filterFTSS5valuePs9AnyObject__DS0_">filter(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Filter (or Equal-to). Query: where term = ‘value’.</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">filter</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery6equalsFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/equals(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery6equalsFTSS5valuePs9AnyObject__DS0_">equals(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Equal-to. Query: where term = ‘value’.</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">equals</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery2eqFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/eq(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery2eqFTSS5valuePs9AnyObject__DS0_">eq(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Equal-to. Query: where term = ‘value’.</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">eq</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addOperationRequirement</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">operation</span><span class="p">:</span><span class="o">.</span><span class="kt">Equal</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery11greaterThanFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/greaterThan(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery11greaterThanFTSS5valuePs9AnyObject__DS0_">greaterThan(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Greater-than. Query: where term > ‘value’.</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">greaterThan</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">gt</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery2gtFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/gt(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery2gtFTSS5valuePs9AnyObject__DS0_">gt(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Greater-than. Query: where term > ‘value’.</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">gt</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addOperationRequirement</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">operation</span><span class="p">:</span><span class="o">.</span><span class="kt">GreaterThan</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery18greaterThanOrEqualFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/greaterThanOrEqual(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery18greaterThanOrEqualFTSS5valuePs9AnyObject__DS0_">greaterThanOrEqual(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Greater-than-or-equal-to. Query: where term >= ‘value’.</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">greaterThanOrEqual</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">gte</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery3gteFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/gte(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3gteFTSS5valuePs9AnyObject__DS0_">gte(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Greater-than-or-equal-to. Query: where term >= ‘value’.</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">gte</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addOperationRequirement</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">operation</span><span class="p">:</span><span class="o">.</span><span class="kt">GreaterThanEqualTo</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery8lessThanFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/lessThan(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery8lessThanFTSS5valuePs9AnyObject__DS0_">lessThan(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Less-than. Query: where term < ‘value’.</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">lessThan</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">lt</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery2ltFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/lt(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery2ltFTSS5valuePs9AnyObject__DS0_">lt(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Less-than. Query: where term < ‘value’.</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">lt</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addOperationRequirement</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">operation</span><span class="p">:</span><span class="o">.</span><span class="kt">LessThan</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery15lessThanOrEqualFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/lessThanOrEqual(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery15lessThanOrEqualFTSS5valuePs9AnyObject__DS0_">lessThanOrEqual(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Less-than-or-equal-to. Query: where term <= ‘value’.</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">lessThanOrEqual</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">lte</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery3lteFTSS5valuePs9AnyObject__DS0_"></a>
- <a name="//apple_ref/swift/Method/lte(_:value:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3lteFTSS5valuePs9AnyObject__DS0_">lte(_:value:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Less-than-or-equal-to. Query: where term <= ‘value’.</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">lte</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">addOperationRequirement</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">operation</span><span class="p">:</span><span class="o">.</span><span class="kt">LessThanEqualTo</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>value</em>
- </code>
- </td>
- <td>
- <div>
- <p>The value.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery14locationWithinFTSf8latitudeSf9longitudeSf_DS0_"></a>
- <a name="//apple_ref/swift/Method/locationWithin(_:latitude:longitude:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery14locationWithinFTSf8latitudeSf9longitudeSf_DS0_">locationWithin(_:latitude:longitude:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Contains. Query: location within val of lat, long.</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">locationWithin</span><span class="p">(</span><span class="nv">distance</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">latitude</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">longitude</span><span class="p">:</span> <span class="kt">Float</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>distance</em>
- </code>
- </td>
- <td>
- <div>
- <p>The distance from the latitude and longitude.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>latitude</em>
- </code>
- </td>
- <td>
- <div>
- <p>The latitude.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>longitude</em>
- </code>
- </td>
- <td>
- <div>
- <p>The longitude.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery2orFT_DS0_"></a>
- <a name="//apple_ref/swift/Method/or()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery2orFT_DS0_">or()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Or operation for conditional queries.</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">or</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery3andFT_DS0_"></a>
- <a name="//apple_ref/swift/Method/and()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3andFT_DS0_">and()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>And operation for conditional queries.</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">and</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery3notFT_DS0_"></a>
- <a name="//apple_ref/swift/Method/not()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3notFT_DS0_">not()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Not operation for conditional queries.</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">not</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridQuery4sortFTSS9sortOrderOS_22UsergridQuerySortOrder_DS0_"></a>
- <a name="//apple_ref/swift/Method/sort(_:sortOrder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery4sortFTSS9sortOrderOS_22UsergridQuerySortOrder_DS0_">sort(_:sortOrder:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort. Query: order by term <code>sortOrder</code></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">sort</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">sortOrder</span><span class="p">:</span> <span class="kt">UsergridQuerySortOrder</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>term</em>
- </code>
- </td>
- <td>
- <div>
- <p>The term.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>sortOrder</em>
- </code>
- </td>
- <td>
- <div>
- <p>The order.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- <
<TRUNCATED>
[15/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html
deleted file mode 100644
index 6ff0433..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html
+++ /dev/null
@@ -1,969 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridResponse 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/UsergridResponse" class="dashAnchor"></a>
- <a title="UsergridResponse 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" />
- UsergridResponse 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>UsergridResponse</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridResponse</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridResponse</code> is the core class that handles both successful and unsuccessful HTTP responses from Usergrid. </p>
-
-<p>If a request is successful, any entities returned in the response will be automatically parsed into <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects and pushed to the <code>entities</code> property.</p>
-
-<p>If a request fails, the <code>UsergridResponseError.error</code> property will contain information about the problem encountered.</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:vC11UsergridSDK16UsergridResponse6clientXwGSqCS_14UsergridClient_"></a>
- <a name="//apple_ref/swift/Property/client" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse6clientXwGSqCS_14UsergridClient_">client</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 that was responsible for the 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">weak</span> <span class="k">var</span> <span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse12responseJSONGSqGVs10DictionarySSPs9AnyObject___"></a>
- <a name="//apple_ref/swift/Property/responseJSON" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse12responseJSONGSqGVs10DictionarySSPs9AnyObject___">responseJSON</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The raw response JSON.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">responseJSON</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></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse5queryGSqCS_13UsergridQuery_"></a>
- <a name="//apple_ref/swift/Property/query" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5queryGSqCS_13UsergridQuery_">query</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The query used on the 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">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse6cursorGSqSS_"></a>
- <a name="//apple_ref/swift/Property/cursor" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse6cursorGSqSS_">cursor</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The cursor from the response.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">cursor</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:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__"></a>
- <a name="//apple_ref/swift/Property/entities" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The entities created from the response JSON.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">entities</span><span class="p">:</span> <span class="p">[</span><span class="kt">UsergridEntity</span><span class="p">]?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse7headersGSqGVs10DictionarySSSS__"></a>
- <a name="//apple_ref/swift/Property/headers" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse7headersGSqGVs10DictionarySSSS__">headers</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The response headers.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">headers</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</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:vC11UsergridSDK16UsergridResponse10statusCodeGSqSi_"></a>
- <a name="//apple_ref/swift/Property/statusCode" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse10statusCodeGSqSi_">statusCode</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The response status code.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">statusCode</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse5errorGSqCS_21UsergridResponseError_"></a>
- <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5errorGSqCS_21UsergridResponseError_">error</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The error object containing error information if one occurred.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse2okSb"></a>
- <a name="//apple_ref/swift/Property/ok" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse2okSb">ok</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns true if the HTTP status code from the response is less than 400.</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">ok</span> <span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse5countSi"></a>
- <a name="//apple_ref/swift/Property/count" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5countSi">count</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The count of <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</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">count</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">entities</span><span class="p">?</span><span class="o">.</span><span class="n">count</span> <span class="p">??</span> <span class="mi">0</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse5firstGSqCS_14UsergridEntity_"></a>
- <a name="//apple_ref/swift/Property/first" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5firstGSqCS_14UsergridEntity_">first</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The first entity in <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</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">first</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span><span class="p">?</span><span class="o">.</span><span class="n">first</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse4lastGSqCS_14UsergridEntity_"></a>
- <a name="//apple_ref/swift/Property/last" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse4lastGSqCS_14UsergridEntity_">last</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The last entity in <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</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">last</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span><span class="p">?</span><span class="o">.</span><span class="n">last</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse6entityGSqCS_14UsergridEntity_"></a>
- <a name="//apple_ref/swift/Property/entity" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse6entityGSqCS_14UsergridEntity_">entity</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The first entity in <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</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">entity</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">first</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse4userGSqCS_12UsergridUser_"></a>
- <a name="//apple_ref/swift/Property/user" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse4userGSqCS_12UsergridUser_">user</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> entity.</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">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span><span class="p">?</span><span class="o">.</span><span class="n">first</span> <span class="k">as?</span> <span class="kt">UsergridUser</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse5usersGSqGSaCS_12UsergridUser__"></a>
- <a name="//apple_ref/swift/Property/users" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5usersGSqGSaCS_12UsergridUser__">users</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>An array of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> entities.</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">users</span><span class="p">:</span> <span class="p">[</span><span class="kt">UsergridUser</span><span class="p">]?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span> <span class="k">as?</span> <span class="p">[</span><span class="kt">UsergridUser</span><span class="p">]</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse11hasNextPageSb"></a>
- <a name="//apple_ref/swift/Property/hasNextPage" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse11hasNextPageSb">hasNextPage</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Does the response have a cursor.</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">hasNextPage</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">cursor</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The string value.</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">stringValue</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:vC11UsergridSDK16UsergridResponse11descriptionSS"></a>
- <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse11descriptionSS">description</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The description.</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">override</span> <span class="k">var</span> <span class="nv">description</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:vC11UsergridSDK16UsergridResponse16debugDescriptionSS"></a>
- <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse16debugDescriptionSS">debugDescription</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The debug description.</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">override</span> <span class="k">var</span> <span class="nv">debugDescription</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:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_9errorNameSS16errorDescriptionSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(client:errorName:errorDescription:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_9errorNameSS16errorDescriptionSS_S0_">init(client:errorName:errorDescription:)</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/UsergridResponse.html">UsergridResponse</a></code> objects that contain errors.</p>
-
-<p>These types of responses are usually created because request conditions are not met.</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">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">?,</span> <span class="nv">errorName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">errorDescription</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client responsible for the request.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>errorName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The error name.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>errorDescription</em>
- </code>
- </td>
- <td>
- <div>
- <p>The error description.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridResponse.html">UsergridResponse</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_4dataGSqCSo6NSData_8responseGSqCSo17NSHTTPURLResponse_5errorGSqCSo7NSError_5queryGSqCS_13UsergridQuery__S0_"></a>
- <a name="//apple_ref/swift/Method/init(client:data:response:error:query:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_4dataGSqCSo6NSData_8responseGSqCSo17NSHTTPURLResponse_5errorGSqCSo7NSError_5queryGSqCS_13UsergridQuery__S0_">init(client:data:response:error:query:)</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/UsergridResponse.html">UsergridResponse</a></code> objects finished but still may contain errors.</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">client</span><span class="p">:</span><span class="kt">UsergridClient</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">response</span><span class="p">:</span><span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span><span class="kt">NSError</span><span class="p">?,</span> <span class="nv">query</span><span class="p">:</span><span class="kt">UsergridQuery</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client responsible for the request.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>data</em>
- </code>
- </td>
- <td>
- <div>
- <p>The response data.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>response</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>NSHTTPURLResponse</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>error</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>NSError</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>query</em>
- </code>
- </td>
- <td>
- <div>
- <p>The query when making the request.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridResponse.html">UsergridResponse</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Instance%20Methods"></a>
- <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
- <a href="#/Instance%20Methods">
- <h3 class="section-name">Instance Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK16UsergridResponse12loadNextPageFFT8responseS0__T_T_"></a>
- <a name="//apple_ref/swift/Method/loadNextPage(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridResponse12loadNextPageFFT8responseS0__T_T_">loadNextPage(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Attempts to load the next page of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects. </p>
-
-<p>This requires a <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse6cursorGSqSS_">cursor</a></code> to be valid as well as a <code>path</code> key within the response JSON.</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">loadNextPage</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that is called once the request for the next page has finished.</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/UsergridResponseError.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponseError.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponseError.html
deleted file mode 100644
index 46fd05a..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponseError.html
+++ /dev/null
@@ -1,473 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridResponseError 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/UsergridResponseError" class="dashAnchor"></a>
- <a title="UsergridResponseError 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" />
- UsergridResponseError 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>UsergridResponseError</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridResponseError</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p>A standard error object that contains details about a request failure.</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:vC11UsergridSDK21UsergridResponseError9errorNameSS"></a>
- <a name="//apple_ref/swift/Property/errorName" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK21UsergridResponseError9errorNameSS">errorName</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The error’s name.</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">errorName</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:vC11UsergridSDK21UsergridResponseError16errorDescriptionSS"></a>
- <a name="//apple_ref/swift/Property/errorDescription" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK21UsergridResponseError16errorDescriptionSS">errorDescription</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The error’s description.</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">errorDescription</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:vC11UsergridSDK21UsergridResponseError9exceptionGSqSS_"></a>
- <a name="//apple_ref/swift/Property/exception" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK21UsergridResponseError9exceptionGSqSS_">exception</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The exception.</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">exception</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:vC11UsergridSDK21UsergridResponseError11descriptionSS"></a>
- <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK21UsergridResponseError11descriptionSS">description</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The description.</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">override</span> <span class="k">var</span> <span class="nv">description</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:vC11UsergridSDK21UsergridResponseError16debugDescriptionSS"></a>
- <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK21UsergridResponseError16debugDescriptionSS">debugDescription</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The debug description.</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">override</span> <span class="k">var</span> <span class="nv">debugDescription</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:FC11UsergridSDK21UsergridResponseErrorcFT9errorNameSS16errorDescriptionSS9exceptionGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(errorName:errorDescription:exception:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK21UsergridResponseErrorcFT9errorNameSS16errorDescriptionSS9exceptionGSqSS__S0_">init(errorName:errorDescription:exception:)</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/UsergridResponseError.html">UsergridResponseError</a></code>.</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">errorName</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">errorDescription</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">exception</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>errorName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The error’s name.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>errorDescription</em>
- </code>
- </td>
- <td>
- <div>
- <p>The error’s description.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>exception</em>
- </code>
- </td>
- <td>
- <div>
- <p>The exception.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridResponseError.html">UsergridResponseError</a></code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK21UsergridResponseErrorcFT14jsonDictionaryGVs10DictionarySSPs9AnyObject___GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(jsonDictionary:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK21UsergridResponseErrorcFT14jsonDictionaryGVs10DictionarySSPs9AnyObject___GSqS0__">init(jsonDictionary:)</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/UsergridResponseError.html">UsergridResponseError</a></code> that determines if the given <code>jsonDictionary</code> contains an error.</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">jsonDictionary</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">])</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>jsonDictionary</em>
- </code>
- </td>
- <td>
- <div>
- <p>The JSON dictionary that may contain error information.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridResponseError.html">UsergridResponseError</a></code> if the JSON dictionary did indeed contain error information.</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>
[48/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/Usergrid.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/Usergrid.swift b/sdks/swift/Source/Usergrid.swift
deleted file mode 100644
index 063d361..0000000
--- a/sdks/swift/Source/Usergrid.swift
+++ /dev/null
@@ -1,637 +0,0 @@
-//
-// Usergrid.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 7/21/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-/// The version number for the Usergrid Swift SDK.
-public let UsergridSDKVersion = "2.1.1"
-
-/**
- The `Usergrid` class acts as a static shared instance manager for the `UsergridClient` class.
-
- The methods and variables in this class are all static and therefore you will never need or want to initialize an instance of the `Usergrid` class.
-
- Use of this class depends on initialization of the shared instance of the `UsergridClient` object. Because of this, before using any of the static methods
- provided you will need to call one of the shared instance initialization methods. Failure to do so will result in failure from all methods.
- */
-public class Usergrid: NSObject {
-
- // MARK: - Static Variables -
-
- internal static var _sharedClient : UsergridClient!
-
- /// Used to determine if the shared instance of the `UsergridClient` has been initialized.
- public static var isInitialized : Bool { return Usergrid._sharedClient != nil }
-
- /**
- A shared instance of `UsergridClient`, used by the `Usergrid` static methods and acts as the default `UsergridClient`
- within the UsergridSDK library.
-
- - Warning: You must call one of the `Usergrid.initSharedInstance` methods before this or any other `Usergrid` static methods are valid.
- */
- public static var sharedInstance : UsergridClient {
- assert(Usergrid.isInitialized, "Usergrid shared instance is not initalized!")
- return Usergrid._sharedClient
- }
-
- /// The application identifier the shared instance of `UsergridClient`.
- public static var appId : String { return Usergrid.sharedInstance.appId }
-
- /// The organization identifier of the shared instance of `UsergridClient`.
- public static var orgId : String { return Usergrid.sharedInstance.orgId }
-
- /// The base URL that all calls will be made with of the shared instance of `UsergridClient`.
- public static var baseUrl : String { return Usergrid.sharedInstance.baseUrl }
-
- /// The constructed URL string based on the `UsergridClient`'s baseUrl, orgId, and appId of the shared instance of `UsergridClient`.
- public static var clientAppURL : String { return Usergrid.sharedInstance.clientAppURL }
-
- /// The currently logged in `UsergridUser` of the shared instance of `UsergridClient`.
- public static var currentUser: UsergridUser? { return Usergrid.sharedInstance.currentUser }
-
- /// Whether or not the current user will be saved and restored from the keychain using the shared instance of `UsergridClient`.
- public static var persistCurrentUserInKeychain: Bool {
- get { return Usergrid.sharedInstance.persistCurrentUserInKeychain }
- set(persist) { Usergrid.sharedInstance.persistCurrentUserInKeychain = persist }
- }
-
- /// The `UsergridUserAuth` which consists of the token information from the `currentUser` property of the shared instance of `UsergridClient`.
- public static var userAuth: UsergridUserAuth? { return Usergrid.sharedInstance.userAuth }
-
- /// The application level `UsergridAppAuth` object of the shared instance of `UsergridClient`.
- public static var appAuth: UsergridAppAuth? {
- get { return Usergrid.sharedInstance.appAuth }
- set(auth) { Usergrid.sharedInstance.appAuth = auth }
- }
-
- /// The `UsergridAuthMode` value used to determine what type of token will be sent of the shared instance of `UsergridClient`, if any.
- public static var authMode: UsergridAuthMode {
- get { return Usergrid.sharedInstance.authMode }
- set(mode) { Usergrid.sharedInstance.authMode = mode }
- }
-
- // MARK: - Initialization -
-
- /**
- Initializes the `Usergrid.sharedInstance` of `UsergridClient`.
-
- - parameter orgId: The organization identifier.
- - parameter appId: The application identifier.
-
- - returns: The shared instance of `UsergridClient`.
- */
- public static func initSharedInstance(orgId orgId : String, appId: String) -> UsergridClient {
- if !Usergrid.isInitialized {
- Usergrid._sharedClient = UsergridClient(orgId: orgId, appId: appId)
- } else {
- print("The Usergrid shared instance was already initialized. All subsequent initialization attempts (including this) will be ignored.")
- }
- return Usergrid._sharedClient
- }
-
- /**
- Initializes the `Usergrid.sharedInstance` of `UsergridClient`.
-
- - parameter orgId: The organization identifier.
- - parameter appId: The application identifier.
- - parameter baseUrl: The base URL that all calls will be made with.
-
- - returns: The shared instance of `UsergridClient`.
- */
- public static func initSharedInstance(orgId orgId : String, appId: String, baseUrl: String) -> UsergridClient {
- if !Usergrid.isInitialized {
- Usergrid._sharedClient = UsergridClient(orgId: orgId, appId: appId, baseUrl: baseUrl)
- } else {
- print("The Usergrid shared instance was already initialized. All subsequent initialization attempts (including this) will be ignored.")
- }
- return Usergrid._sharedClient
- }
-
- /**
- Initializes the `Usergrid.sharedInstance` of `UsergridClient`.
-
- - parameter configuration: The configuration for the client to be set up with.
-
- - returns: The shared instance of `UsergridClient`.
- */
- public static func initSharedInstance(configuration configuration: UsergridClientConfig) -> UsergridClient {
- if !Usergrid.isInitialized {
- Usergrid._sharedClient = UsergridClient(configuration: configuration)
- } else {
- print("The Usergrid shared instance was already initialized. All subsequent initialization attempts (including this) will be ignored.")
- }
- return Usergrid._sharedClient
- }
-
- // MARK: - Push Notifications -
-
- /**
- Sets the push token for the given notifier ID and performs a PUT request to update the shared `UsergridDevice` instance using the shared instance of `UsergridCient`.
-
- - parameter pushToken: The push token from Apple.
- - parameter notifierID: The Usergrid notifier ID.
- - parameter completion: The completion block.
- */
- public static func applyPushToken(pushToken: NSData, notifierID: String, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.applyPushToken(pushToken, notifierID: notifierID, completion: completion)
- }
-
- /**
- Sets the push token for the given notifier ID and performs a PUT request to update the given `UsergridDevice` instance using the shared instance of `UsergridCient`.
-
- - parameter device: The `UsergridDevice` object.
- - parameter pushToken: The push token from Apple.
- - parameter notifierID: The Usergrid notifier ID.
- - parameter completion: The completion block.
- */
- public static func applyPushToken(device: UsergridDevice, pushToken: NSData, notifierID: String, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.applyPushToken(device, pushToken: pushToken, notifierID: notifierID, completion: completion)
- }
-
-
- // MARK: - Authorization -
-
- /**
- Sets the shared `UsergridClient`'s `tempAuth` property using the passed in `UsergridAuth`.
-
- This will cause the next CRUD method performed by the client to use the `tempAuth` property once and will then reset.
-
- - parameter auth: The `UsergridAuth` object to temporarily use for authentication.
-
- - returns: The shared instance of `UsergridClient`
- */
- public static func usingAuth(auth:UsergridAuth) -> UsergridClient {
- return Usergrid.sharedInstance.usingAuth(auth)
- }
-
- /**
- Sets the shared `UsergridClient`'s `tempAuth` property using the passed in token.
-
- This will cause the next CRUD method performed by the client to use the `tempAuth` property once and will then reset.
-
- - parameter auth: The access token to temporarily use for authentication.
-
- - returns: The shared instance of `UsergridClient`
- */
- public static func usingToken(token:String) -> UsergridClient {
- return Usergrid.sharedInstance.usingToken(token)
- }
-
-
- /**
- Determines the `UsergridAuth` object that will be used for all outgoing requests made by the shared instance of `UsergridClient`.
-
- If there is a `UsergridUser` logged in and the token of that user is valid then it will return that.
-
- Otherwise, if the `authMode` is `.App`, and the `UsergridAppAuth` of the client is set and the token is valid it will return that.
-
- - returns: The `UsergridAuth` if one is found or nil if not.
- */
- public static func authForRequests() -> UsergridAuth? {
- return Usergrid.sharedInstance.authForRequests()
- }
-
- /**
- Authenticates with the `UsergridAppAuth` that is contained within the shared instance of `UsergridCient`.
-
- - parameter completion: The completion block that will be called after authentication has completed.
- */
- public static func authenticateApp(completion: UsergridAppAuthCompletionBlock? = nil) {
- Usergrid.sharedInstance.authenticateApp(completion)
- }
-
- /**
- Authenticates with the `UsergridAppAuth` that is passed in using the shared instance of `UsergridCient`.
-
- - parameter auth: The `UsergridAppAuth` that will be authenticated.
- - parameter completion: The completion block that will be called after authentication has completed.
- */
- public static func authenticateApp(auth: UsergridAppAuth, completion: UsergridAppAuthCompletionBlock? = nil) {
- Usergrid.sharedInstance.authenticateApp(auth, completion: completion)
- }
-
- /**
- Authenticates with the `UsergridUserAuth` that is passed in using the shared instance of `UsergridCient`.
-
- - parameter auth: The `UsergridUserAuth` that will be authenticated.
- - parameter completion: The completion block that will be called after authentication has completed.
- */
- public static func authenticateUser(auth: UsergridUserAuth, completion: UsergridUserAuthCompletionBlock? = nil) {
- Usergrid.sharedInstance.authenticateUser(auth, completion: completion)
- }
-
- /**
- Authenticates with the `UsergridUserAuth` that is passed in using the shared instance of `UsergridCient`.
-
- - parameter auth: The `UsergridUserAuth` that will be authenticated.
- - parameter setAsCurrentUser: If the authenticated user should be set as the `UsergridClient.currentUser`.
- - parameter completion: The completion block that will be called after authentication has completed.
- */
- public static func authenticateUser(userAuth: UsergridUserAuth, setAsCurrentUser:Bool, completion: UsergridUserAuthCompletionBlock? = nil) {
- Usergrid.sharedInstance.authenticateUser(userAuth, setAsCurrentUser: setAsCurrentUser, completion: completion)
- }
-
- /**
- Changes the given `UsergridUser`'s current password with the shared instance of `UsergridClient`.
-
- - parameter user: The user.
- - parameter old: The old password.
- - parameter new: The new password.
- - parameter completion: The optional completion block.
- */
- public static func resetPassword(user: UsergridUser, old:String, new:String, completion:UsergridUserResetPasswordCompletion? = nil) {
- Usergrid.sharedInstance.resetPassword(user, old: old, new: new, completion: completion)
- }
-
- /**
- Logs out the current user of the shared instance locally and remotely using the shared instance of `UsergridClient`.
-
- - parameter completion: The completion block that will be called after logout has completed.
- */
- public static func logoutCurrentUser(completion:UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.logoutCurrentUser(completion)
- }
-
- /**
- Logs out the user remotely with the given tokens using the shared instance of `UsergridCient`.
-
- - parameter completion: The completion block that will be called after logout has completed.
- */
- public static func logoutUserAllTokens(uuidOrUsername:String, completion:UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.logoutUserAllTokens(uuidOrUsername, completion: completion)
- }
-
- /**
- Logs out a user with the give UUID or username using the shared instance of `UsergridCient`.
-
- Passing in a token will log out the user for just that token. Passing in nil for the token will logout the user for all tokens.
-
- - parameter completion: The completion block that will be called after logout has completed.
- */
- public static func logoutUser(uuidOrUsername:String, token:String?, completion:UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.logoutUser(uuidOrUsername, token: token, completion: completion)
- }
-
- // MARK: - Generic Request Methods -
-
- /**
- Starts the `UsergridRequest` sending process using the shared instance of `UsergridCient`.
-
- - Note: This method should only be used when you construct your own `UsergridRequest objects.
-
- - parameter request: The `UsergridRequest` object to send.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public static func sendRequest(request:UsergridRequest, completion:UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.sendRequest(request, completion: completion)
- }
-
- // MARK: - GET -
-
- /**
- Gets a single `UsergridEntity` of a given type with a specific UUID/name using the shared instance of `UsergridCient`.
-
- - parameter type: The `UsergridEntity` type.
- - parameter uuidOrName: The UUID or name of the `UsergridEntity`.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func GET(type: String, uuidOrName: String, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.GET(type,uuidOrName:uuidOrName,completion:completion)
- }
-
- /**
- Gets a group of `UsergridEntity` objects of a given type using the shared instance of `UsergridCient`.
-
- - parameter type: The `UsergridEntity` type.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public static func GET(type: String, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.GET(type,completion:completion)
- }
-
- /**
- Gets a group of `UsergridEntity` objects with a given query using the shared instance of `UsergridCient`.
-
- - parameter query: The query to use when gathering `UsergridEntity` objects.
- - parameter queryCompletion: The completion block that will be called once the request has completed.
- */
- public static func GET(query: UsergridQuery, queryCompletion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.GET(query,queryCompletion:queryCompletion)
- }
-
- // MARK: - PUT -
-
- /**
- Updates an `UsergridEntity` with the given type and UUID/name specified using the passed in jsonBody using the shared instance of `UsergridCient`.
-
- - parameter type: The `UsergridEntity` type.
- - parameter uuidOrName: The UUID or name of the `UsergridEntity`.
- - parameter jsonBody: The valid JSON body dictionary to update the `UsergridEntity` with.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func PUT(type: String, uuidOrName: String, jsonBody:[String:AnyObject], completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.PUT(type, uuidOrName: uuidOrName, jsonBody: jsonBody, completion: completion)
- }
-
- /**
- Updates an `UsergridEntity` with the given type using the jsonBody where the UUID/name is specified inside of the jsonBody using the shared instance of `UsergridCient`.
-
- - Note: The `jsonBody` must contain a valid value for either `uuid` or `name`.
-
- - parameter type: The `UsergridEntity` type.
- - parameter jsonBody: The valid JSON body dictionary to update the `UsergridEntity` with.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func PUT(type: String, jsonBody:[String:AnyObject], completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.PUT(type, jsonBody: jsonBody, completion: completion)
- }
-
- /**
- Updates the passed in `UsergridEntity` using the shared instance of `UsergridCient`.
-
- - parameter entity: The `UsergridEntity` to update.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func PUT(entity: UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.PUT(entity, completion: completion)
- }
-
- /**
- Updates the entities that fit the given query using the passed in jsonBody using the shared instance of `UsergridCient`.
-
- - Note: The query parameter must have a valid `collectionName` before calling this method.
-
- - parameter query: The query to use when filtering what entities to update.
- - parameter jsonBody: The valid JSON body dictionary to update with.
- - parameter queryCompletion: The completion block that will be called once the request has completed.
- */
- public static func PUT(query: UsergridQuery, jsonBody:[String:AnyObject], queryCompletion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.PUT(query, jsonBody: jsonBody, queryCompletion: queryCompletion)
- }
-
- // MARK: - POST -
-
- /**
- Creates and posts an `UsergridEntity` of the given type with a given name and the given jsonBody using the shared instance of `UsergridCient`.
-
- - parameter type: The `UsergridEntity` type.
- - parameter name: The name of the `UsergridEntity`.
- - parameter jsonBody: The valid JSON body dictionary to use when creating the `UsergridEntity`.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func POST(type: String, name: String, jsonBody:[String:AnyObject], completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.POST(type, name: name, jsonBody: jsonBody, completion: completion)
- }
-
- /**
- Creates and posts an `UsergridEntity` of the given type with the given jsonBody using the shared instance of `UsergridCient`.
-
- - parameter type: The `UsergridEntity` type.
- - parameter jsonBody: The valid JSON body dictionary to use when creating the `UsergridEntity`.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func POST(type: String, jsonBody:[String:AnyObject], completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.POST(type, jsonBody: jsonBody, completion: completion)
- }
-
- /**
- Creates and posts an array of `Entity` objects while assinging the given type to them using the shared instance of `UsergridCient`.
-
- - parameter type: The `UsergridEntity` type.
- - parameter jsonBody: The valid JSON body dictionaries to use when creating the `UsergridEntity` objects.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func POST(type: String, jsonBodies:[[String:AnyObject]], completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.POST(type, jsonBodies: jsonBodies, completion: completion)
- }
-
- /**
- Creates and posts creates an `UsergridEntity` using the shared instance of `UsergridCient`.
-
- - parameter entity: The `UsergridEntity` to create.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func POST(entity:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.POST(entity, completion: completion)
- }
-
- /**
- Creates and posts an array of `UsergridEntity` objects using the shared instance of `UsergridCient`.
-
- - Note: Each `UsergridEntity` in the array much already have a type assigned and must be the same.
-
- - parameter entities: The `UsergridEntity` objects to create.
- - parameter entitiesCompletion: The completion block that will be called once the request has completed.
- */
- public static func POST(entities:[UsergridEntity], entitiesCompletion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.POST(entities, entitiesCompletion: entitiesCompletion)
- }
-
- // MARK: - DELETE -
-
- /**
- Destroys the `UsergridEntity` of a given type with a specific UUID/name using the shared instance of `UsergridCient`.
-
- - parameter type: The `UsergridEntity` type.
- - parameter uuidOrName: The UUID or name of the `UsergridEntity`.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func DELETE(type:String, uuidOrName: String, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.DELETE(type, uuidOrName: uuidOrName, completion: completion)
- }
-
- /**
- Destroys the passed `UsergridEntity` using the shared instance of `UsergridCient`.
-
- - Note: The entity object must have a `uuid` or `name` assigned.
-
- - parameter entity: The `UsergridEntity` to delete.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func DELETE(entity:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.DELETE(entity, completion:completion)
- }
-
- /**
- Destroys the `UsergridEntity` objects that fit the given `UsergridQuery` using the shared instance of `UsergridCient`.
-
- - Note: The query parameter must have a valid `collectionName` before calling this method.
-
- - parameter query: The query to use when filtering what entities to delete.
- - parameter queryCompletion: The completion block that will be called once the request has completed.
- */
- public static func DELETE(query:UsergridQuery, queryCompletion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.DELETE(query, queryCompletion:queryCompletion)
- }
-
- // MARK: - Connection Management -
-
- /**
- Connects the `UsergridEntity` objects via the relationship using the shared instance of `UsergridCient`.
-
- - parameter entity: The entity that will contain the connection.
- - parameter relationship: The relationship of the two entities.
- - parameter to: The entity which is connected.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func connect(entity:UsergridEntity, relationship:String, to:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.connect(entity, relationship: relationship, to: to, completion: completion)
- }
-
- /**
- Connects the entity objects via the relationship using the shared instance of `UsergridCient`.
-
- - parameter entityType: The entity type.
- - parameter entityID: The entity UUID or name.
- - parameter relationship: The relationship of the connection.
- - parameter toType: The optional type of the entity you are connecting to.
- - parameter toID: The UUID of the entity you are connecting to.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func connect(entityType:String, entityID:String, relationship:String, toType:String?, toID: String, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.connect(entityType, entityID: entityID, relationship: relationship, toType: toType, toID: toID, completion: completion)
- }
-
- /**
- Connects the entity objects via the relationship using the shared instance of `UsergridCient`.
-
- - parameter entityType: The entity type.
- - parameter entityID: The entity UUID or name.
- - parameter relationship: The relationship of the connection.
- - parameter toType: The type of the entity you are connecting to.
- - parameter toName: The name of the entity you are connecting to.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func connect(entityType:String, entityID:String, relationship:String, toType:String, toName: String, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.connect(entityType, entityID: entityID, relationship: relationship, toType: toType, toName: toName, completion: completion)
- }
-
-
- /**
- Disconnects the `UsergridEntity` objects via the relationship using the shared instance of `UsergridCient`.
-
- - parameter entity: The entity that contains the connection.
- - parameter relationship: The relationship of the two entities.
- - parameter connectingEntity: The entity which is connected.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func disconnect(entity:UsergridEntity, relationship:String, from:UsergridEntity, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.disconnect(entity, relationship: relationship, from: from, completion: completion)
- }
-
- /**
- Disconnects the entity objects via the relationship using the shared instance of `UsergridCient`.
-
- - parameter entityType: The entity type.
- - parameter entityID: The entity UUID or name.
- - parameter relationship: The relationship of the connection.
- - parameter fromType: The optional type of the entity you are disconnecting from.
- - parameter toID: The UUID of the entity you are disconnecting from.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func disconnect(entityType:String, entityID:String, relationship:String, fromType:String?, fromID: String, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.disconnect(entityType, entityID: entityID, relationship: relationship, fromType: fromType, fromID: fromID, completion: completion)
- }
-
- /**
- Disconnects the entity objects via the relationship using the shared instance of `UsergridCient`.
-
- - parameter entityType: The entity type.
- - parameter entityID: The entity UUID or name.
- - parameter relationship: The relationship of the connection.
- - parameter fromType: The type of the entity you are disconnecting from.
- - parameter fromName: The name of the entity you are disconnecting from.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func disconnect(entityType:String, entityID:String, relationship:String, fromType:String, fromName: String, completion: UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.disconnect(entityType, entityID: entityID, relationship: relationship, fromType: fromType, fromName: fromName, completion: completion)
- }
-
- /**
- Gets the connected entities for the given relationship using the shared instance of `UsergridCient`.
-
- - parameter direction: The direction of the connection.
- - parameter entity: The entity that contains the connection.
- - parameter relationship: The relationship.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func getConnections(direction:UsergridDirection, entity:UsergridEntity, relationship:String, query:UsergridQuery? = nil, completion:UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.getConnections(direction, entity: entity, relationship: relationship, query:query, completion: completion)
- }
-
- /**
- Gets the connected entities for the given relationship using the shared instance of `UsergridCient`.
-
- - parameter direction: The direction of the connection.
- - parameter type: The entity type.
- - parameter uuidOrName: The entity UUID or name.
- - parameter relationship: The relationship of the connection.
- - parameter query: The optional query.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func getConnections(direction:UsergridDirection, type:String, uuidOrName:String, relationship:String, query:UsergridQuery? = nil, completion:UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.getConnections(direction, type: type, uuidOrName: uuidOrName, relationship: relationship, query:query, completion: completion)
- }
-
- /**
- Gets the connected entities for the given relationship using the shared instance of `UsergridCient`.
-
- - parameter direction: The direction of the connection.
- - parameter uuid: The entity UUID.
- - parameter relationship: The relationship of the connection.
- - parameter query: The optional query.
- - parameter completion: The optional completion block that will be called once the request has completed.
- */
- public static func getConnections(direction:UsergridDirection, uuid:String, relationship:String, query:UsergridQuery? = nil, completion:UsergridResponseCompletion? = nil) {
- Usergrid.sharedInstance.getConnections(direction, uuid: uuid, relationship: relationship, query: query, completion: completion)
- }
-
- // MARK: - Asset Management -
-
- /**
- Uploads the asset and connects the data to the given `UsergridEntity` using the shared instance of `UsergridCient`.
-
- - parameter entity: The entity to connect the asset to.
- - parameter asset: The asset to upload.
- - parameter progress: The progress block that will be called to update the progress of the upload.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func uploadAsset(entity:UsergridEntity, asset:UsergridAsset, progress:UsergridAssetRequestProgress? = nil, completion:UsergridAssetUploadCompletion? = nil) {
- Usergrid.sharedInstance.uploadAsset(entity, asset: asset, progress: progress, completion: completion)
- }
-
- /**
- Downloads the asset from the given `UsergridEntity` using the shared instance of `UsergridCient`.
-
- - parameter entity: The entity to which the asset to.
- - parameter contentType: The content type of the asset's data.
- - parameter progress: The progress block that will be called to update the progress of the download.
- - parameter completion: The completion block that will be called once the request has completed.
- */
- public static func downloadAsset(entity:UsergridEntity, contentType:String, progress:UsergridAssetRequestProgress? = nil, completion:UsergridAssetDownloadCompletion? = nil) {
- Usergrid.sharedInstance.downloadAsset(entity, contentType: contentType, progress: progress, completion: completion)
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridAsset.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridAsset.swift b/sdks/swift/Source/UsergridAsset.swift
deleted file mode 100644
index 9353ec1..0000000
--- a/sdks/swift/Source/UsergridAsset.swift
+++ /dev/null
@@ -1,198 +0,0 @@
-//
-// UsergridAsset.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/21/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-#if os(iOS) || os(watchOS) || os(tvOS)
-import UIKit
-import MobileCoreServices
-#endif
-
-/// The progress block used in `UsergridAsset` are being uploaded or downloaded.
-public typealias UsergridAssetRequestProgress = (bytesFinished:Int64, bytesExpected: Int64) -> Void
-
-/// The completion block used in `UsergridAsset` are finished uploading.
-public typealias UsergridAssetUploadCompletion = (asset:UsergridAsset?, response: UsergridResponse) -> Void
-
-/// The completion block used in `UsergridAsset` are finished downloading.
-public typealias UsergridAssetDownloadCompletion = (asset:UsergridAsset?, error: UsergridResponseError?) -> Void
-
-/**
-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 `UsergridEntity` class.
-
-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.
-*/
-public class UsergridAsset: NSObject, NSCoding {
-
- internal static let DEFAULT_FILE_NAME = "file"
-
- // MARK: - Instance Properties -
-
- /// The filename to be used in the multipart/form-data request.
- public let filename: String
-
- /// Binary representation of the asset's data.
- public let data: NSData
-
- /// A representation of the folder location the asset was loaded from, if it was provided in the initialization.
- public let originalLocation: String?
-
- /// The Content-type of the asset to be used when defining content-type inside the multipart/form-data request.
- public var contentType: String
-
- /// The content length of the assets data.
- public var contentLength: Int { return self.data.length }
-
- // MARK: - Initialization -
-
- /**
- Designated initializer for `UsergridAsset` objects.
-
- - parameter fileName: The file name associated with the file data.
- - parameter data: The data of the file.
- - parameter originalLocation: An optional original location of the file.
- - parameter contentType: The content type of the file.
-
- - returns: A new instance of `UsergridAsset`.
- */
- public init(filename:String? = UsergridAsset.DEFAULT_FILE_NAME, data:NSData, originalLocation:String? = nil, contentType:String) {
- self.filename = filename ?? UsergridAsset.DEFAULT_FILE_NAME
- self.data = data
- self.originalLocation = originalLocation
- self.contentType = contentType
- }
-
- #if os(iOS) || os(watchOS) || os(tvOS)
- /**
- Convenience initializer for `UsergridAsset` objects dealing with image data.
-
- - parameter fileName: The file name associated with the file data.
- - parameter image: The `UIImage` object to upload.
- - parameter imageContentType: The content type of the `UIImage`
-
- - returns: A new instance of `UsergridAsset` if the data can be gathered from the passed in `UIImage`, otherwise nil.
- */
- public convenience init?(filename:String? = UsergridAsset.DEFAULT_FILE_NAME, image:UIImage, imageContentType:UsergridImageContentType = .Png) {
- var imageData: NSData?
- switch(imageContentType) {
- case .Png :
- imageData = UIImagePNGRepresentation(image)
- case .Jpeg :
- imageData = UIImageJPEGRepresentation(image, 1.0)
- }
- if let assetData = imageData {
- self.init(filename:filename,data:assetData,contentType:imageContentType.stringValue)
- } else {
- self.init(filename:"",data:NSData(),contentType:"")
- return nil
- }
- }
- #endif
-
- /**
- Convenience initializer for `UsergridAsset` objects dealing directly with files on disk.
-
- - parameter fileName: The file name associated with the file data.
- - parameter fileURL: The `NSURL` object associated with the file.
- - parameter contentType: The content type of the `UIImage`. If not specified it will try to figure out the type and if it can't initialization will fail.
-
- - returns: A new instance of `UsergridAsset` if the data can be gathered from the passed in `NSURL`, otherwise nil.
- */
- public convenience init?(filename:String? = UsergridAsset.DEFAULT_FILE_NAME, fileURL:NSURL, contentType:String? = nil) {
- if fileURL.fileURL, let assetData = NSData(contentsOfURL: fileURL) {
- var fileNameToUse = filename
- if fileNameToUse != UsergridAsset.DEFAULT_FILE_NAME, let inferredFileName = fileURL.lastPathComponent {
- fileNameToUse = inferredFileName
- }
- if let fileContentType = contentType ?? UsergridAsset.MIMEType(fileURL) {
- self.init(filename:fileNameToUse,data:assetData,originalLocation:fileURL.absoluteString,contentType:fileContentType)
- } else {
- print("Usergrid Error: Failed to imply content type of the asset.")
- self.init(filename:"",data:NSData(),contentType:"")
- return nil
- }
- } else {
- print("Usergrid Error: fileURL parameter must be a file URL.")
- self.init(filename:"",data:NSData(),contentType:"")
- return nil
- }
- }
-
- // MARK: - NSCoding -
-
- /**
- NSCoding protocol initializer.
-
- - parameter aDecoder: The decoder.
-
- - returns: A decoded `UsergridUser` object.
- */
- required public init?(coder aDecoder: NSCoder) {
- guard let filename = aDecoder.decodeObjectForKey("filename") as? String,
- let assetData = aDecoder.decodeObjectForKey("data") as? NSData,
- let contentType = aDecoder.decodeObjectForKey("contentType") as? String
- else {
- self.filename = ""
- self.contentType = ""
- self.originalLocation = nil
- self.data = NSData()
- super.init()
- return nil
- }
- self.filename = filename
- self.data = assetData
- self.contentType = contentType
- self.originalLocation = aDecoder.decodeObjectForKey("originalLocation") as? String
- super.init()
- }
-
- /**
- NSCoding protocol encoder.
-
- - parameter aCoder: The encoder.
- */
- public func encodeWithCoder(aCoder: NSCoder) {
- aCoder.encodeObject(self.filename, forKey: "filename")
- aCoder.encodeObject(self.data, forKey: "data")
- aCoder.encodeObject(self.contentType, forKey: "contentType")
- aCoder.encodeObject(self.originalLocation, forKey: "originalLocation")
- }
-
- private static func MIMEType(fileURL: NSURL) -> String? {
- if let pathExtension = fileURL.pathExtension {
- if let UTIRef = UTTypeCreatePreferredIdentifierForTag(kUTTagClassFilenameExtension, pathExtension, nil) {
- let UTI = UTIRef.takeUnretainedValue()
- UTIRef.release()
- if let MIMETypeRef = UTTypeCopyPreferredTagWithClass(UTI, kUTTagClassMIMEType) {
- let MIMEType = MIMETypeRef.takeUnretainedValue()
- MIMETypeRef.release()
- return MIMEType as String
- }
- }
- }
- return nil
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridAssetRequestWrapper.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridAssetRequestWrapper.swift b/sdks/swift/Source/UsergridAssetRequestWrapper.swift
deleted file mode 100644
index d715652..0000000
--- a/sdks/swift/Source/UsergridAssetRequestWrapper.swift
+++ /dev/null
@@ -1,48 +0,0 @@
-//
-// UsergridAssetRequestWrapper.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 10/1/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-typealias UsergridAssetRequestWrapperCompletionBlock = (requestWrapper:UsergridAssetRequestWrapper) -> Void
-
-final class UsergridAssetRequestWrapper {
- weak var session: NSURLSession?
- let sessionTask: NSURLSessionTask
-
- var response: NSURLResponse?
- var responseData: NSData?
- var error: NSError?
-
- var progress: UsergridAssetRequestProgress?
- let completion: UsergridAssetRequestWrapperCompletionBlock
-
- init(session:NSURLSession?, sessionTask:NSURLSessionTask, progress:UsergridAssetRequestProgress?, completion:UsergridAssetRequestWrapperCompletionBlock) {
- self.session = session
- self.sessionTask = sessionTask
- self.progress = progress
- self.completion = completion
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridAuth.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridAuth.swift b/sdks/swift/Source/UsergridAuth.swift
deleted file mode 100644
index e87e9c1..0000000
--- a/sdks/swift/Source/UsergridAuth.swift
+++ /dev/null
@@ -1,276 +0,0 @@
-//
-// UsergridAuth.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/11/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-/// The completion block used in `UsergridAppAuth` authentication methods.
-public typealias UsergridAppAuthCompletionBlock = (auth:UsergridAppAuth?, error: UsergridResponseError?) -> Void
-
-/// The completion block used in `UsergridUserAuth` authentication methods.
-public typealias UsergridUserAuthCompletionBlock = (auth:UsergridUserAuth?, user:UsergridUser?, error: UsergridResponseError?) -> Void
-
-/**
- The `UsergridAuth` class functions to create and store authentication information used by Usergrid.
-
- The `UsergridAuth` sub classes, `UsergridAppAuth` and `UsergridUserAuth`, provide different ways for authentication to be used in creating requests for access tokens through the SDK.
-*/
-public class UsergridAuth : NSObject, NSCoding {
-
- // MARK: - Instance Properties -
-
- /// The access token, if this `UsergridAuth` was authorized successfully.
- public var accessToken : String?
-
- /// The expires at date, if this `UsergridAuth` was authorized successfully and their was a expires in time stamp within the token response.
- public var expiry : NSDate?
-
- /// Determines if an access token exists.
- public var hasToken: Bool { return self.accessToken != nil }
-
- /// Determines if the token was set explicitly within the init method or not.
- private var usingToken: Bool = false
-
- /// Determines if an access token exists and if the token is not expired.
- public var isValid : Bool { return self.hasToken && !self.isExpired }
-
- /// Determines if the access token, if one exists, is expired.
- public var isExpired: Bool {
- var isExpired = false
- if let expires = self.expiry {
- isExpired = expires.timeIntervalSinceNow < 0.0
- } else {
- isExpired = !self.usingToken
- }
- return isExpired
- }
-
- /// The credentials dictionary. Subclasses must override this method and provide an actual dictionary containing the credentials to send with requests.
- var credentialsJSONDict: [String:AnyObject] {
- return [:]
- }
-
- // MARK: - Initialization -
-
- /**
- Internal initialization method. Note this should never be used outside of internal methods.
-
- - returns: A new instance of `UsergridAuth`.
- */
- override private init() {
- super.init()
- }
-
- /**
- Initializer for a base `UsergridAuth` object that just contains an `accessToken` and an optional `expiry` date.
-
- - parameter accessToken: The access token.
- - parameter expiry: The optional expiry date.
-
- - returns: A new instance of `UsergridAuth`
- */
- public init(accessToken:String, expiry:NSDate? = nil) {
- self.usingToken = true
- self.accessToken = accessToken
- self.expiry = expiry
- }
-
- // MARK: - NSCoding -
-
- /**
- NSCoding protocol initializer.
-
- - parameter aDecoder: The decoder.
-
- - returns: A decoded `UsergridAuth` object.
- */
- required public init?(coder aDecoder: NSCoder) {
- self.accessToken = aDecoder.decodeObjectForKey("accessToken") as? String
- self.expiry = aDecoder.decodeObjectForKey("expiry") as? NSDate
- }
-
- /**
- NSCoding protocol encoder.
-
- - parameter aCoder: The encoder.
- */
- public func encodeWithCoder(aCoder: NSCoder) {
- if let accessToken = self.accessToken {
- aCoder.encodeObject(accessToken, forKey: "accessToken")
- }
- if let expiresAt = self.expiry {
- aCoder.encodeObject(expiresAt, forKey: "expiry")
- }
- }
-
- // MARK: - Instance Methods -
-
- /**
- Destroys/removes the access token and expiry.
- */
- public func destroy() {
- self.accessToken = nil
- self.expiry = nil
- }
-}
-
-/// The `UsergridAuth` subclass used for user level authorization.
-public class UsergridUserAuth : UsergridAuth {
-
- // MARK: - Instance Properties -
-
- /// The username associated with the User.
- public let username: String
-
- /// The password associated with the User.
- private let password: String
-
- /// The credentials dictionary constructed with the `UsergridUserAuth`'s `username` and `password`.
- override var credentialsJSONDict: [String:AnyObject] {
- return ["grant_type":"password",
- "username":self.username,
- "password":self.password]
- }
-
- // MARK: - Initialization -
-
- /**
- Designated initializer for `UsergridUserAuth` objects.
-
- - parameter username: The username associated with the User.
- - parameter password: The password associated with the User.
-
- - returns: A new instance of `UsergridUserAuth`.
- */
- public init(username:String, password: String){
- self.username = username
- self.password = password
- super.init()
- }
-
- // MARK: - NSCoding -
-
- /**
- NSCoding protocol initializer.
-
- - parameter aDecoder: The decoder.
-
- - returns: A decoded `UsergridUserAuth` object.
- */
- required public init?(coder aDecoder: NSCoder) {
- guard let username = aDecoder.decodeObjectForKey("username") as? String,
- password = aDecoder.decodeObjectForKey("password") as? String
- else {
- self.username = ""
- self.password = ""
- super.init(coder: aDecoder)
- return nil
- }
-
- self.username = username
- self.password = password
- super.init(coder: aDecoder)
- }
-
- /**
- NSCoding protocol encoder.
-
- - parameter aCoder: The encoder.
- */
- override public func encodeWithCoder(aCoder: NSCoder) {
- aCoder.encodeObject(self.username, forKey: "username")
- aCoder.encodeObject(self.password, forKey: "password")
- super.encodeWithCoder(aCoder)
- }
-}
-
-/// The `UsergridAuth` subclass used for application level authorization.
-public class UsergridAppAuth : UsergridAuth {
-
- // MARK: - Instance Properties -
-
- /// The client identifier associated with the application.
- public let clientId: String
-
- /// The client secret associated with the application.
- private let clientSecret: String
-
- /// The credentials dictionary constructed with the `UsergridAppAuth`'s `clientId` and `clientSecret`.
- override var credentialsJSONDict: [String:AnyObject] {
- return ["grant_type":"client_credentials",
- "client_id":self.clientId,
- "client_secret":self.clientSecret]
- }
-
- // MARK: - Initialization -
-
- /**
- Designated initializer for `UsergridAppAuth` objects.
-
- - parameter clientId: The client identifier associated with the application.
- - parameter clientSecret: The client secret associated with the application.
-
- - returns: A new instance of `UsergridAppAuth`.
- */
- public init(clientId:String,clientSecret:String){
- self.clientId = clientId
- self.clientSecret = clientSecret
- super.init()
- }
-
- // MARK: - NSCoding -
-
- /**
- NSCoding protocol initializer.
-
- - parameter aDecoder: The decoder.
-
- - returns: A decoded `UsergridAppAuth` object.
- */
- required public init?(coder aDecoder: NSCoder) {
- guard let clientId = aDecoder.decodeObjectForKey("clientId") as? String,
- let clientSecret = aDecoder.decodeObjectForKey("clientSecret") as? String
- else {
- self.clientId = ""
- self.clientSecret = ""
- super.init(coder: aDecoder)
- return nil
- }
- self.clientId = clientId
- self.clientSecret = clientSecret
- super.init(coder: aDecoder)
- }
-
- /**
- NSCoding protocol encoder.
-
- - parameter aCoder: The encoder.
- */
- override public func encodeWithCoder(aCoder: NSCoder) {
- aCoder.encodeObject(self.clientId, forKey: "clientId")
- aCoder.encodeObject(self.clientSecret, forKey: "clientSecret")
- super.encodeWithCoder(aCoder)
- }
-}
\ No newline at end of file
[26/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Global Variables.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Global Variables.html b/sdks/swift/docs/Global Variables.html
deleted file mode 100644
index 2685313..0000000
--- a/sdks/swift/docs/Global Variables.html
+++ /dev/null
@@ -1,210 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Global Variables 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 title="Global Variables 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" />
- Global Variables 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>Global Variables</h1>
- <p>The following global variables are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:v11UsergridSDK18UsergridSDKVersionSS"></a>
- <a name="//apple_ref/swift/Global/UsergridSDKVersion" class="dashAnchor"></a>
- <a class="token" href="#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The version number for the Usergrid Swift SDK.</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">UsergridSDKVersion</span> <span class="o">=</span> <span class="s">"2.1.1"</span></code></pre>
-
- </div>
- </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/Protocols.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Protocols.html b/sdks/swift/docs/Protocols.html
deleted file mode 100644
index 7e9f435..0000000
--- a/sdks/swift/docs/Protocols.html
+++ /dev/null
@@ -1,146 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Protocols 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 title="Protocols Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="index.html"> Docs</a> (46% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="index.html"> Reference</a>
- <img id="carat" src="img/carat.png" />
- Protocols 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/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/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/UsergridResponse.html">UsergridResponse</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="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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="Extensions/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="Protocols/UsergridAuth.html">UsergridAuth</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>Protocols</h1>
- <p>The following protocols are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:P11UsergridSDK12UsergridAuth"></a>
- <a name="//apple_ref/swift/Protocol/UsergridAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:P11UsergridSDK12UsergridAuth">UsergridAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- <a href="Protocols/UsergridAuth.html" class="slightly-smaller">See more</a>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-21)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/Protocols/UsergridAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Protocols/UsergridAuth.html b/sdks/swift/docs/Protocols/UsergridAuth.html
deleted file mode 100644
index dfaaf0d..0000000
--- a/sdks/swift/docs/Protocols/UsergridAuth.html
+++ /dev/null
@@ -1,260 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuth Protocol 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/Protocol/UsergridAuth" class="dashAnchor"></a>
- <a title="UsergridAuth Protocol Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html"> Docs</a> (46% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> Reference</a>
- <img id="carat" src="../img/carat.png" />
- UsergridAuth Protocol 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/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/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/UsergridResponse.html">UsergridResponse</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="../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="../Extensions/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Protocols/UsergridAuth.html">UsergridAuth</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridAuth</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth11accessTokenGSqSS_"></a>
- <a name="//apple_ref/swift/Property/accessToken" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth9expiresInGSqSi_"></a>
- <a name="//apple_ref/swift/Property/expiresIn" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth9expiresInGSqSi_">expiresIn</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth8hasTokenSb"></a>
- <a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth8hasTokenSb">hasToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth12tokenIsValidSb"></a>
- <a name="//apple_ref/swift/Property/tokenIsValid" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth12tokenIsValidSb">tokenIsValid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth9isExpiredSb"></a>
- <a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth9isExpiredSb">isExpired</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth12jsonBodyDictGVSs10DictionarySSPSs9AnyObject__"></a>
- <a name="//apple_ref/swift/Property/jsonBodyDict" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth12jsonBodyDictGVSs10DictionarySSPSs9AnyObject__">jsonBodyDict</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FP11UsergridSDK12UsergridAuth16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest"></a>
- <a name="//apple_ref/swift/Method/buildAuthRequest(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FP11UsergridSDK12UsergridAuth16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest">buildAuthRequest(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-21)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/Typealiases.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Typealiases.html b/sdks/swift/docs/Typealiases.html
deleted file mode 100644
index 4a5b04a..0000000
--- a/sdks/swift/docs/Typealiases.html
+++ /dev/null
@@ -1,411 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Typealiases 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 title="Typealiases 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" />
- Typealiases 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>Typealiases</h1>
- <p>The following typealiases are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK30UsergridAppAuthCompletionBlock"></a>
- <a name="//apple_ref/swift/Alias/UsergridAppAuthCompletionBlock" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used in <code><a href="Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> authentication methods.</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">typealias</span> <span class="kt">UsergridAppAuthCompletionBlock</span> <span class="o">=</span> <span class="p">(</span><span class="nv">auth</span><span class="p">:</span><span class="kt">UsergridAppAuth</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK31UsergridUserAuthCompletionBlock"></a>
- <a name="//apple_ref/swift/Alias/UsergridUserAuthCompletionBlock" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used in <code><a href="Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> authentication methods.</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">typealias</span> <span class="kt">UsergridUserAuthCompletionBlock</span> <span class="o">=</span> <span class="p">(</span><span class="nv">auth</span><span class="p">:</span><span class="kt">UsergridUserAuth</span><span class="p">?,</span> <span class="nv">user</span><span class="p">:</span><span class="kt">UsergridUser</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK34UsergridUserAvailabilityCompletion"></a>
- <a name="//apple_ref/swift/Alias/UsergridUserAvailabilityCompletion" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used for checking email and/or username availablity for new <code><a href="Classes/UsergridUser.html">UsergridUser</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="kd">typealias</span> <span class="kt">UsergridUserAvailabilityCompletion</span> <span class="o">=</span> <span class="p">(</span><span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?,</span> <span class="nv">available</span><span class="p">:</span><span class="kt">Bool</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK35UsergridUserResetPasswordCompletion"></a>
- <a name="//apple_ref/swift/Alias/UsergridUserResetPasswordCompletion" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used for changing the password of <code><a href="Classes/UsergridUser.html">UsergridUser</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="kd">typealias</span> <span class="kt">UsergridUserResetPasswordCompletion</span> <span class="o">=</span> <span class="p">(</span><span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?,</span> <span class="nv">didSucceed</span><span class="p">:</span><span class="kt">Bool</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK26UsergridResponseCompletion"></a>
- <a name="//apple_ref/swift/Alias/UsergridResponseCompletion" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used in for most <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> requests.</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">typealias</span> <span class="kt">UsergridResponseCompletion</span> <span class="o">=</span> <span class="p">(</span><span class="nv">response</span><span class="p">:</span> <span class="kt">UsergridResponse</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK28UsergridAssetRequestProgress"></a>
- <a name="//apple_ref/swift/Alias/UsergridAssetRequestProgress" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The progress block used in <code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> are being uploaded or downloaded.</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">typealias</span> <span class="kt">UsergridAssetRequestProgress</span> <span class="o">=</span> <span class="p">(</span><span class="nv">bytesFinished</span><span class="p">:</span><span class="kt">Int64</span><span class="p">,</span> <span class="nv">bytesExpected</span><span class="p">:</span> <span class="kt">Int64</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK29UsergridAssetUploadCompletion"></a>
- <a name="//apple_ref/swift/Alias/UsergridAssetUploadCompletion" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used in <code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> are finished 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="kd">typealias</span> <span class="kt">UsergridAssetUploadCompletion</span> <span class="o">=</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> <span class="nv">response</span><span class="p">:</span> <span class="kt">UsergridResponse</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK31UsergridAssetDownloadCompletion"></a>
- <a name="//apple_ref/swift/Alias/UsergridAssetDownloadCompletion" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used in <code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> are finished downloading.</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">typealias</span> <span class="kt">UsergridAssetDownloadCompletion</span> <span class="o">=</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> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </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/css/highlight.css
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/css/highlight.css b/sdks/swift/docs/css/highlight.css
deleted file mode 100644
index d0db0e1..0000000
--- a/sdks/swift/docs/css/highlight.css
+++ /dev/null
@@ -1,200 +0,0 @@
-/* Credit to https://gist.github.com/wataru420/2048287 */
-.highlight {
- /* Comment */
- /* Error */
- /* Keyword */
- /* Operator */
- /* Comment.Multiline */
- /* Comment.Preproc */
- /* Comment.Single */
- /* Comment.Special */
- /* Generic.Deleted */
- /* Generic.Deleted.Specific */
- /* Generic.Emph */
- /* Generic.Error */
- /* Generic.Heading */
- /* Generic.Inserted */
- /* Generic.Inserted.Specific */
- /* Generic.Output */
- /* Generic.Prompt */
- /* Generic.Strong */
- /* Generic.Subheading */
- /* Generic.Traceback */
- /* Keyword.Constant */
- /* Keyword.Declaration */
- /* Keyword.Pseudo */
- /* Keyword.Reserved */
- /* Keyword.Type */
- /* Literal.Number */
- /* Literal.String */
- /* Name.Attribute */
- /* Name.Builtin */
- /* Name.Class */
- /* Name.Constant */
- /* Name.Entity */
- /* Name.Exception */
- /* Name.Function */
- /* Name.Namespace */
- /* Name.Tag */
- /* Name.Variable */
- /* Operator.Word */
- /* Text.Whitespace */
- /* Literal.Number.Float */
- /* Literal.Number.Hex */
- /* Literal.Number.Integer */
- /* Literal.Number.Oct */
- /* Literal.String.Backtick */
- /* Literal.String.Char */
- /* Literal.String.Doc */
- /* Literal.String.Double */
- /* Literal.String.Escape */
- /* Literal.String.Heredoc */
- /* Literal.String.Interpol */
- /* Literal.String.Other */
- /* Literal.String.Regex */
- /* Literal.String.Single */
- /* Literal.String.Symbol */
- /* Name.Builtin.Pseudo */
- /* Name.Variable.Class */
- /* Name.Variable.Global */
- /* Name.Variable.Instance */
- /* Literal.Number.Integer.Long */ }
- .highlight .c {
- color: #999988;
- font-style: italic; }
- .highlight .err {
- color: #a61717;
- background-color: #e3d2d2; }
- .highlight .k {
- color: #000000;
- font-weight: bold; }
- .highlight .o {
- color: #000000;
- font-weight: bold; }
- .highlight .cm {
- color: #999988;
- font-style: italic; }
- .highlight .cp {
- color: #999999;
- font-weight: bold; }
- .highlight .c1 {
- color: #999988;
- font-style: italic; }
- .highlight .cs {
- color: #999999;
- font-weight: bold;
- font-style: italic; }
- .highlight .gd {
- color: #000000;
- background-color: #ffdddd; }
- .highlight .gd .x {
- color: #000000;
- background-color: #ffaaaa; }
- .highlight .ge {
- color: #000000;
- font-style: italic; }
- .highlight .gr {
- color: #aa0000; }
- .highlight .gh {
- color: #999999; }
- .highlight .gi {
- color: #000000;
- background-color: #ddffdd; }
- .highlight .gi .x {
- color: #000000;
- background-color: #aaffaa; }
- .highlight .go {
- color: #888888; }
- .highlight .gp {
- color: #555555; }
- .highlight .gs {
- font-weight: bold; }
- .highlight .gu {
- color: #aaaaaa; }
- .highlight .gt {
- color: #aa0000; }
- .highlight .kc {
- color: #000000;
- font-weight: bold; }
- .highlight .kd {
- color: #000000;
- font-weight: bold; }
- .highlight .kp {
- color: #000000;
- font-weight: bold; }
- .highlight .kr {
- color: #000000;
- font-weight: bold; }
- .highlight .kt {
- color: #445588; }
- .highlight .m {
- color: #009999; }
- .highlight .s {
- color: #d14; }
- .highlight .na {
- color: #008080; }
- .highlight .nb {
- color: #0086B3; }
- .highlight .nc {
- color: #445588;
- font-weight: bold; }
- .highlight .no {
- color: #008080; }
- .highlight .ni {
- color: #800080; }
- .highlight .ne {
- color: #990000;
- font-weight: bold; }
- .highlight .nf {
- color: #990000; }
- .highlight .nn {
- color: #555555; }
- .highlight .nt {
- color: #000080; }
- .highlight .nv {
- color: #008080; }
- .highlight .ow {
- color: #000000;
- font-weight: bold; }
- .highlight .w {
- color: #bbbbbb; }
- .highlight .mf {
- color: #009999; }
- .highlight .mh {
- color: #009999; }
- .highlight .mi {
- color: #009999; }
- .highlight .mo {
- color: #009999; }
- .highlight .sb {
- color: #d14; }
- .highlight .sc {
- color: #d14; }
- .highlight .sd {
- color: #d14; }
- .highlight .s2 {
- color: #d14; }
- .highlight .se {
- color: #d14; }
- .highlight .sh {
- color: #d14; }
- .highlight .si {
- color: #d14; }
- .highlight .sx {
- color: #d14; }
- .highlight .sr {
- color: #009926; }
- .highlight .s1 {
- color: #d14; }
- .highlight .ss {
- color: #990073; }
- .highlight .bp {
- color: #999999; }
- .highlight .vc {
- color: #008080; }
- .highlight .vg {
- color: #008080; }
- .highlight .vi {
- color: #008080; }
- .highlight .il {
- color: #009999; }
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/css/jazzy.css
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/css/jazzy.css b/sdks/swift/docs/css/jazzy.css
deleted file mode 100644
index 2a7da3a..0000000
--- a/sdks/swift/docs/css/jazzy.css
+++ /dev/null
@@ -1,331 +0,0 @@
-html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
- background: transparent;
- border: 0;
- margin: 0;
- outline: 0;
- padding: 0;
- vertical-align: baseline; }
-
-body {
- background-color: #f2f2f2;
- font-family: Helvetica, freesans, Arial, sans-serif;
- font-size: 14px;
- -webkit-font-smoothing: subpixel-antialiased;
- word-wrap: break-word; }
-
-h1, h2, h3 {
- margin-top: 0.8em;
- margin-bottom: 0.3em;
- font-weight: 100;
- color: black; }
-
-h1 {
- font-size: 2.5em; }
-
-h2 {
- font-size: 2em;
- border-bottom: 1px solid #e2e2e2; }
-
-h4 {
- font-size: 13px;
- line-height: 1.5;
- margin-top: 21px; }
-
-h5 {
- font-size: 1.1em; }
-
-h6 {
- font-size: 1.1em;
- color: #777; }
-
-.section-name {
- color: gray;
- display: block;
- font-family: Helvetica;
- font-size: 22px;
- font-weight: 100;
- margin-bottom: 15px; }
-
-pre, code {
- font: 0.95em Menlo, monospace;
- color: #777;
- word-wrap: normal; }
-
-p code, li code {
- background-color: #eee;
- padding: 2px 4px;
- border-radius: 4px; }
-
-a {
- color: #0088cc;
- text-decoration: none; }
-
-ul {
- padding-left: 15px; }
-
-li {
- line-height: 1.8em; }
-
-img {
- max-width: 100%; }
-
-blockquote {
- margin-left: 0;
- padding: 0 10px;
- border-left: 4px solid #ccc; }
-
-.content-wrapper {
- margin: 0 auto;
- width: 980px; }
-
-header {
- font-size: 0.85em;
- line-height: 26px;
- background-color: #414141;
- position: fixed;
- width: 100%;
- z-index: 1; }
- header img {
- padding-right: 6px;
- vertical-align: -4px;
- height: 16px; }
- header a {
- color: #fff; }
- header p {
- float: left;
- color: #999; }
- header .header-right {
- float: right;
- margin-left: 16px; }
-
-#breadcrumbs {
- background-color: #f2f2f2;
- height: 27px;
- padding-top: 17px;
- position: fixed;
- width: 100%;
- z-index: 1;
- margin-top: 26px; }
- #breadcrumbs #carat {
- height: 10px;
- margin: 0 5px; }
-
-.sidebar {
- background-color: #f9f9f9;
- border: 1px solid #e2e2e2;
- overflow-y: auto;
- overflow-x: hidden;
- position: fixed;
- top: 70px;
- bottom: 0;
- width: 230px;
- word-wrap: normal; }
-
-.nav-groups {
- list-style-type: none;
- background: #fff;
- padding-left: 0; }
-
-.nav-group-name {
- border-bottom: 1px solid #e2e2e2;
- font-size: 1.1em;
- font-weight: 100;
- padding: 15px 0 15px 20px; }
- .nav-group-name > a {
- color: #333; }
-
-.nav-group-tasks {
- margin-top: 5px; }
-
-.nav-group-task {
- font-size: 0.9em;
- list-style-type: none; }
- .nav-group-task a {
- color: #888; }
-
-.main-content {
- background-color: #fff;
- border: 1px solid #e2e2e2;
- margin-left: 246px;
- position: absolute;
- overflow: hidden;
- padding-bottom: 60px;
- top: 70px;
- width: 734px; }
- .main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote {
- margin-bottom: 1em; }
- .main-content p {
- line-height: 1.8em; }
- .main-content section .section:first-child {
- margin-top: 0;
- padding-top: 0; }
- .main-content section .task-group-section .task-group:first-of-type {
- padding-top: 10px; }
- .main-content section .task-group-section .task-group:first-of-type .section-name {
- padding-top: 15px; }
-
-.section {
- padding: 0 25px; }
-
-.highlight {
- background-color: #eee;
- padding: 10px 12px;
- border: 1px solid #e2e2e2;
- border-radius: 4px;
- overflow-x: auto; }
-
-.declaration .highlight {
- overflow-x: initial;
- padding: 0 40px 40px 0;
- margin-bottom: -25px;
- background-color: transparent;
- border: none; }
-
-.section-name {
- margin: 0;
- margin-left: 18px; }
-
-.task-group-section {
- padding-left: 6px;
- border-top: 1px solid #e2e2e2; }
-
-.task-group {
- padding-top: 0px; }
-
-.task-name-container a[name]:before {
- content: "";
- display: block;
- padding-top: 70px;
- margin: -70px 0 0; }
-
-.item {
- padding-top: 8px;
- width: 100%;
- list-style-type: none; }
- .item a[name]:before {
- content: "";
- display: block;
- padding-top: 70px;
- margin: -70px 0 0; }
- .item code {
- background-color: transparent;
- padding: 0; }
- .item .token {
- padding-left: 3px;
- margin-left: 15px;
- font-size: 11.9px; }
- .item .declaration-note {
- font-size: .85em;
- color: gray;
- font-style: italic; }
-
-.pointer-container {
- border-bottom: 1px solid #e2e2e2;
- left: -23px;
- padding-bottom: 13px;
- position: relative;
- width: 110%; }
-
-.pointer {
- background: #f9f9f9;
- border-left: 1px solid #e2e2e2;
- border-top: 1px solid #e2e2e2;
- height: 12px;
- left: 21px;
- top: -7px;
- -webkit-transform: rotate(45deg);
- -moz-transform: rotate(45deg);
- -o-transform: rotate(45deg);
- transform: rotate(45deg);
- position: absolute;
- width: 12px; }
-
-.height-container {
- display: none;
- left: -25px;
- padding: 0 25px;
- position: relative;
- width: 100%;
- overflow: hidden; }
- .height-container .section {
- background: #f9f9f9;
- border-bottom: 1px solid #e2e2e2;
- left: -25px;
- position: relative;
- width: 100%;
- padding-top: 10px;
- padding-bottom: 5px; }
-
-.aside, .language {
- padding: 6px 12px;
- margin: 12px 0;
- border-left: 5px solid #dddddd;
- overflow-y: hidden; }
- .aside .aside-title, .language .aside-title {
- font-size: 9px;
- letter-spacing: 2px;
- text-transform: uppercase;
- padding-bottom: 0;
- margin: 0;
- color: #aaa;
- -webkit-user-select: none; }
- .aside p:last-child, .language p:last-child {
- margin-bottom: 0; }
-
-.language {
- border-left: 5px solid #cde9f4; }
- .language .aside-title {
- color: #4b8afb; }
-
-.aside-warning {
- border-left: 5px solid #ff6666; }
- .aside-warning .aside-title {
- color: #ff0000; }
-
-.graybox {
- border-collapse: collapse;
- width: 100%; }
- .graybox p {
- margin: 0;
- word-break: break-word;
- min-width: 50px; }
- .graybox td {
- border: 1px solid #e2e2e2;
- padding: 5px 25px 5px 10px;
- vertical-align: middle; }
- .graybox tr td:first-of-type {
- text-align: right;
- padding: 7px;
- vertical-align: top;
- word-break: normal;
- width: 40px; }
-
-.slightly-smaller {
- font-size: 0.9em; }
-
-#footer {
- position: absolute;
- bottom: 10px;
- margin-left: 25px; }
- #footer p {
- margin: 0;
- color: #aaa;
- font-size: 0.8em; }
-
-html.dash header, html.dash #breadcrumbs, html.dash .sidebar {
- display: none; }
-html.dash .main-content {
- width: 980px;
- margin-left: 0;
- border: none;
- width: 100%;
- top: 0;
- padding-bottom: 0; }
-html.dash .height-container {
- display: block; }
-html.dash .item .token {
- margin-left: 0; }
-html.dash .content-wrapper {
- width: auto; }
-html.dash #footer {
- position: static; }
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Info.plist
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Info.plist b/sdks/swift/docs/docsets/.docset/Contents/Info.plist
deleted file mode 100644
index 4fcbfbd..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Info.plist
+++ /dev/null
@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
- <dict>
- <key>CFBundleIdentifier</key>
- <string>com.jazzy.</string>
- <key>CFBundleName</key>
- <string></string>
- <key>DocSetPlatformFamily</key>
- <string>jazzy</string>
- <key>isDashDocset</key>
- <true/>
- <key>dashIndexFilePath</key>
- <string>index.html</string>
- <key>isJavaScriptEnabled</key>
- <true/>
- <key>DashDocSetFamily</key>
- <string>dashtoc</string>
- </dict>
-</plist>
[25/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes.html
deleted file mode 100644
index c6b6e22..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes.html
+++ /dev/null
@@ -1,702 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Classes 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 title="Classes 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" />
- Classes 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>Classes</h1>
- <p>The following classes are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK21UsergridResponseError"></a>
- <a name="//apple_ref/swift/Class/UsergridResponseError" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK21UsergridResponseError">UsergridResponseError</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A standard error object that contains details about a request failure.</p>
-
- <a href="Classes/UsergridResponseError.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridResponseError</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK15UsergridRequest"></a>
- <a name="//apple_ref/swift/Class/UsergridRequest" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK15UsergridRequest">UsergridRequest</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The UsergridRequest class incapsulates the properties that all requests made by the SDK have in common. </p>
-
-<p>This class is also functions to create <code>NSURLRequest</code> objects based on the properties of the class.</p>
-
- <a href="Classes/UsergridRequest.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridRequest</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK26UsergridAssetUploadRequest"></a>
- <a name="//apple_ref/swift/Class/UsergridAssetUploadRequest" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK26UsergridAssetUploadRequest">UsergridAssetUploadRequest</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="Classes/UsergridRequest.html">UsergridRequest</a></code> sub class which is used for uploading assets.</p>
-
- <a href="Classes/UsergridAssetUploadRequest.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridAssetUploadRequest</span><span class="p">:</span> <span class="kt">UsergridRequest</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK20UsergridClientConfig"></a>
- <a name="//apple_ref/swift/Class/UsergridClientConfig" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK20UsergridClientConfig">UsergridClientConfig</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridClientConfig</code> is used when initializing <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> objects.</p>
-
-<p>The <code>UsergridClientConfig</code> is meant for further customization of <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> objects when needed.</p>
-
- <a href="Classes/UsergridClientConfig.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridClientConfig</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK12UsergridAuth"></a>
- <a name="//apple_ref/swift/Class/UsergridAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK12UsergridAuth">UsergridAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>UsergridAuth</code> class functions to create and store authentication information used by Usergrid.</p>
-
-<p>The <code>UsergridAuth</code> sub classes, <code><a href="Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> and <code><a href="Classes/UsergridUserAuth.html">UsergridUserAuth</a></code>, provide different ways for authentication to be used in creating requests for access tokens through the SDK.</p>
-
- <a href="Classes/UsergridAuth.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK16UsergridUserAuth"></a>
- <a name="//apple_ref/swift/Class/UsergridUserAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK16UsergridUserAuth">UsergridUserAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="Classes/UsergridAuth.html">UsergridAuth</a></code> subclass used for user level authorization.</p>
-
- <a href="Classes/UsergridUserAuth.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridUserAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK15UsergridAppAuth"></a>
- <a name="//apple_ref/swift/Class/UsergridAppAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK15UsergridAppAuth">UsergridAppAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="Classes/UsergridAuth.html">UsergridAuth</a></code> subclass used for application level authorization.</p>
-
- <a href="Classes/UsergridAppAuth.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridAppAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK20UsergridFileMetaData"></a>
- <a name="//apple_ref/swift/Class/UsergridFileMetaData" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK20UsergridFileMetaData">UsergridFileMetaData</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridFileMetaData</code> is a helper class for dealing with reading <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> file meta data.</p>
-
- <a href="Classes/UsergridFileMetaData.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridFileMetaData</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span><span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK14UsergridDevice"></a>
- <a name="//apple_ref/swift/Class/UsergridDevice" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK14UsergridDevice">UsergridDevice</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridDevice</code> is an <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> subclass that encapsulates information about the current device as well as stores information about push tokens and Usergrid notifiers.</p>
-
-<p>To apply push tokens for Usergrid notifiers use the <code>UsergridClient.applyPushToken</code> method.</p>
-
- <a href="Classes/UsergridDevice.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridDevice</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK13UsergridQuery"></a>
- <a name="//apple_ref/swift/Class/UsergridQuery" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK13UsergridQuery">UsergridQuery</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridQuery</code> is builder class used to construct filtered requests to Usergrid.</p>
-
-<p><code>UsergridQuery</code> objects are then passed to <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> or <code><a href="Classes/Usergrid.html">Usergrid</a></code> methods which support <code>UsergridQuery</code> as a parameter are .GET(), .PUT(), and .DELETE().</p>
-
- <a href="Classes/UsergridQuery.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridQuery</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span><span class="kt">NSCopying</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK14UsergridEntity"></a>
- <a name="//apple_ref/swift/Class/UsergridEntity" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK14UsergridEntity">UsergridEntity</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridEntity</code> is the base class that contains a single Usergrid entity. </p>
-
-<p><code>UsergridEntity</code> maintains a set of accessor properties for standard Usergrid schema properties (e.g. name, uuid), and supports helper methods for accessing any custom properties that might exist.</p>
-
- <a href="Classes/UsergridEntity.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridEntity</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK12UsergridUser"></a>
- <a name="//apple_ref/swift/Class/UsergridUser" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK12UsergridUser">UsergridUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridUser</code> is a special subclass of <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> that supports functions and properties unique to users.</p>
-
- <a href="Classes/UsergridUser.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridUser</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK8Usergrid"></a>
- <a name="//apple_ref/swift/Class/Usergrid" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK8Usergrid">Usergrid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>Usergrid</code> class acts as a static shared instance manager for the <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> class.</p>
-
-<p>The methods and variables in this class are all static and therefore you will never need or want to initialize an instance of the <code>Usergrid</code> class.</p>
-
-<p>Use of this class depends on initialization of the shared instance of the <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> object. Because of this, before using any of the static methods
-provided you will need to call one of the shared instance initialization methods. Failure to do so will result in failure from all methods.</p>
-
- <a href="Classes/Usergrid.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">Usergrid</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK16UsergridResponse"></a>
- <a name="//apple_ref/swift/Class/UsergridResponse" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK16UsergridResponse">UsergridResponse</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridResponse</code> is the core class that handles both successful and unsuccessful HTTP responses from Usergrid. </p>
-
-<p>If a request is successful, any entities returned in the response will be automatically parsed into <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> objects and pushed to the <code>entities</code> property.</p>
-
-<p>If a request fails, the <code>UsergridResponseError.error</code> property will contain information about the problem encountered.</p>
-
- <a href="Classes/UsergridResponse.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridResponse</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK13UsergridAsset"></a>
- <a name="//apple_ref/swift/Class/UsergridAsset" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK13UsergridAsset">UsergridAsset</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
-
- <a href="Classes/UsergridAsset.html" class="slightly-smaller">See more</a>
- </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">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>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK14UsergridClient"></a>
- <a name="//apple_ref/swift/Class/UsergridClient" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK14UsergridClient">UsergridClient</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>UsergridClient</code> class is the base handler for making client connections to and managing relationships with Usergrid’s API.</p>
-
- <a href="Classes/UsergridClient.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridClient</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </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>
[46/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridEnums.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridEnums.swift b/sdks/swift/Source/UsergridEnums.swift
deleted file mode 100644
index fd0b625..0000000
--- a/sdks/swift/Source/UsergridEnums.swift
+++ /dev/null
@@ -1,417 +0,0 @@
-//
-// UsergridEnums.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 10/21/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-/**
-An enumeration that is used to determine what the `UsergridClient` will use for authorization.
-*/
-@objc public enum UsergridAuthMode : Int {
-
- // MARK: - Values -
-
- /**
- If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.
- */
- case None
-
- /**
- If a non-expired `UsergridUserAuth` exists in `UsergridClient.currentUser`, this token is used to authenticate all API calls.
-
- If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).
- */
- case User
-
- /**
- If a non-expired `UsergridAppAuth` exists in `UsergridClient.appAuth`, this token is used to authenticate all API calls.
-
- If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).
- */
- case App
-}
-
-/**
-`UsergridEntity` specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.
-*/
-@objc public enum UsergridEntityProperties : Int {
-
- // MARK: - Values -
-
- /// Corresponds to the property 'type'
- case EntityType
- /// Corresponds to the property 'uuid'
- case UUID
- /// Corresponds to the property 'name'
- case Name
- /// Corresponds to the property 'created'
- case Created
- /// Corresponds to the property 'modified'
- case Modified
- /// Corresponds to the property 'location'
- case Location
-
- // MARK: - Methods -
-
- /**
- Gets the corresponding `UsergridEntityProperties` from a string if it's valid.
-
- - parameter stringValue: The string value to convert.
-
- - returns: The corresponding `UsergridEntityProperties` or nil.
- */
- public static func fromString(stringValue: String) -> UsergridEntityProperties? {
- switch stringValue.lowercaseString {
- case ENTITY_TYPE: return .EntityType
- case ENTITY_UUID: return .UUID
- case ENTITY_NAME: return .Name
- case ENTITY_CREATED: return .Created
- case ENTITY_MODIFIED: return .Modified
- case ENTITY_LOCATION: return .Location
- default: return nil
- }
- }
-
- /// Returns the string value.
- public var stringValue: String {
- switch self {
- case .EntityType: return ENTITY_TYPE
- case .UUID: return ENTITY_UUID
- case .Name: return ENTITY_NAME
- case .Created: return ENTITY_CREATED
- case .Modified: return ENTITY_MODIFIED
- case .Location: return ENTITY_LOCATION
- }
- }
-
- /**
- Determines if the `UsergridEntityProperties` is mutable for the given entity.
-
- - parameter entity: The entity to check.
-
- - returns: If the `UsergridEntityProperties` is mutable for the given entity
- */
- public func isMutableForEntity(entity:UsergridEntity) -> Bool {
- switch self {
- case .EntityType,.UUID,.Created,.Modified: return false
- case .Location: return true
- case .Name: return entity.isUser
- }
- }
-}
-
-/**
-`UsergridDeviceProperties` specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.
-*/
-@objc public enum UsergridDeviceProperties : Int {
-
- // MARK: - Values -
-
- /// Corresponds to the property 'deviceModel'
- case Model
- /// Corresponds to the property 'devicePlatform'
- case Platform
- /// Corresponds to the property 'deviceOSVersion'
- case OSVersion
-
- // MARK: - Methods -
-
- /**
- Gets the corresponding `UsergridDeviceProperties` from a string if it's valid.
-
- - parameter stringValue: The string value to convert.
-
- - returns: The corresponding `UsergridDeviceProperties` or nil.
- */
- public static func fromString(stringValue: String) -> UsergridDeviceProperties? {
- switch stringValue.lowercaseString {
- case DEVICE_MODEL: return .Model
- case DEVICE_PLATFORM: return .Platform
- case DEVICE_OSVERSION: return .OSVersion
- default: return nil
- }
- }
-
- /// Returns the string value.
- public var stringValue: String {
- switch self {
- case .Model: return DEVICE_MODEL
- case .Platform: return DEVICE_PLATFORM
- case .OSVersion: return DEVICE_OSVERSION
- }
- }
-}
-
-/**
-`UsergridUser` specific properties keys.
-*/
-@objc public enum UsergridUserProperties: Int {
-
- // MARK: - Values -
-
- /// Corresponds to the property 'name'
- case Name
- /// Corresponds to the property 'username'
- case Username
- /// Corresponds to the property 'password'
- case Password
- /// Corresponds to the property 'email'
- case Email
- /// Corresponds to the property 'age'
- case Age
- /// Corresponds to the property 'activated'
- case Activated
- /// Corresponds to the property 'disabled'
- case Disabled
- /// Corresponds to the property 'picture'
- case Picture
-
- // MARK: - Methods -
-
- /**
- Gets the corresponding `UsergridUserProperties` from a string if it's valid.
-
- - parameter stringValue: The string value to convert.
-
- - returns: The corresponding `UsergridUserProperties` or nil.
- */
- public static func fromString(stringValue: String) -> UsergridUserProperties? {
- switch stringValue.lowercaseString {
- case ENTITY_NAME: return .Name
- case USER_USERNAME: return .Username
- case USER_PASSWORD: return .Password
- case USER_EMAIL: return .Email
- case USER_AGE: return .Age
- case USER_ACTIVATED: return .Activated
- case USER_DISABLED: return .Disabled
- case USER_PICTURE: return .Picture
- default: return nil
- }
- }
-
- /// Returns the string value.
- public var stringValue: String {
- switch self {
- case .Name: return ENTITY_NAME
- case .Username: return USER_USERNAME
- case .Password: return USER_PASSWORD
- case .Email: return USER_EMAIL
- case .Age: return USER_AGE
- case .Activated: return USER_ACTIVATED
- case .Disabled: return USER_DISABLED
- case .Picture: return USER_PICTURE
- }
- }
-}
-
-/**
-`UsergridQuery` specific operators.
-*/
-@objc public enum UsergridQueryOperator: Int {
-
- // MARK: - Values -
-
- /// '='
- case Equal
- /// '>'
- case GreaterThan
- /// '>='
- case GreaterThanEqualTo
- /// '<'
- case LessThan
- /// '<='
- case LessThanEqualTo
-
- // MARK: - Methods -
-
- /**
- Gets the corresponding `UsergridQueryOperator` from a string if it's valid.
-
- - parameter stringValue: The string value to convert.
-
- - returns: The corresponding `UsergridQueryOperator` or nil.
- */
- public static func fromString(stringValue: String) -> UsergridQueryOperator? {
- switch stringValue.lowercaseString {
- case UsergridQuery.EQUAL: return .Equal
- case UsergridQuery.GREATER_THAN: return .GreaterThan
- case UsergridQuery.GREATER_THAN_EQUAL_TO: return .GreaterThanEqualTo
- case UsergridQuery.LESS_THAN: return .LessThan
- case UsergridQuery.LESS_THAN_EQUAL_TO: return .LessThanEqualTo
- default: return nil
- }
- }
-
- /// Returns the string value.
- public var stringValue: String {
- switch self {
- case .Equal: return UsergridQuery.EQUAL
- case .GreaterThan: return UsergridQuery.GREATER_THAN
- case .GreaterThanEqualTo: return UsergridQuery.GREATER_THAN_EQUAL_TO
- case .LessThan: return UsergridQuery.LESS_THAN
- case .LessThanEqualTo: return UsergridQuery.LESS_THAN_EQUAL_TO
- }
- }
-}
-
-/**
-`UsergridQuery` specific sort orders.
-*/
-@objc public enum UsergridQuerySortOrder: Int {
-
- // MARK: - Values -
-
- /// Sort order is ascending.
- case Asc
- /// Sort order is descending.
- case Desc
-
- // MARK: - Methods -
-
- /**
- Gets the corresponding `UsergridQuerySortOrder` from a string if it's valid.
-
- - parameter stringValue: The string value to convert.
-
- - returns: The corresponding `UsergridQuerySortOrder` or nil.
- */
- public static func fromString(stringValue: String) -> UsergridQuerySortOrder? {
- switch stringValue.lowercaseString {
- case UsergridQuery.ASC: return .Asc
- case UsergridQuery.DESC: return .Desc
- default: return nil
- }
- }
-
- /// Returns the string value.
- public var stringValue: String {
- switch self {
- case .Asc: return UsergridQuery.ASC
- case .Desc: return UsergridQuery.DESC
- }
- }
-}
-
-/**
-`UsergridAsset` image specific content types.
-*/
-@objc public enum UsergridImageContentType : Int {
-
- // MARK: - Values -
-
- /// Content type: 'image/png'
- case Png
- /// Content type: 'image/jpeg'
- case Jpeg
-
- // MARK: - Methods -
-
- /// Returns the string value.
- public var stringValue: String {
- switch self {
- case .Png: return ASSET_IMAGE_PNG
- case .Jpeg: return ASSET_IMAGE_JPEG
- }
- }
-}
-
-/**
- An enumeration that is used when getting connections to entity objects. Used to determine which the direction of the connection is wanted.
- */
-@objc public enum UsergridDirection : Int {
-
- // MARK: - Values -
-
- /// To get the entities that have created a connection to an entity. aka `connecting`
- case In
-
- /// To get the entities an entity has connected to. aka `connections`
- case Out
-
- // MARK: - Methods -
-
- /// Returns the connection value.
- public var connectionValue: String {
- switch self {
- case .In: return CONNECTION_TYPE_IN
- case .Out: return CONNECTION_TYPE_OUT
- }
- }
-}
-
-/**
- An enumeration for defining the HTTP methods used by Usergrid.
- */
-@objc public enum UsergridHttpMethod : Int {
-
- /// GET
- case Get
-
- /// PUT
- case Put
-
- /// POST
- case Post
-
- /// DELETE
- case Delete
-
- /// Returns the string value.
- public var stringValue: String {
- switch self {
- case .Get: return "GET"
- case .Put: return "PUT"
- case .Post: return "POST"
- case .Delete: return "DELETE"
- }
- }
-}
-
-let ENTITY_TYPE = "type"
-let ENTITY_UUID = "uuid"
-let ENTITY_NAME = "name"
-let ENTITY_CREATED = "created"
-let ENTITY_MODIFIED = "modified"
-let ENTITY_LOCATION = "location"
-let ENTITY_LATITUDE = "latitude"
-let ENTITY_LONGITUDE = "longitude"
-
-let USER_USERNAME = "username"
-let USER_PASSWORD = "password"
-let USER_EMAIL = "email"
-let USER_AGE = "age"
-let USER_ACTIVATED = "activated"
-let USER_DISABLED = "disabled"
-let USER_PICTURE = "picture"
-
-let DEVICE_MODEL = "deviceModel"
-let DEVICE_PLATFORM = "devicePlatform"
-let DEVICE_OSVERSION = "deviceOSVersion"
-
-let ASSET_IMAGE_PNG = "image/png"
-let ASSET_IMAGE_JPEG = "image/jpeg"
-
-let CONNECTION_TYPE_IN = "connecting"
-let CONNECTION_TYPE_OUT = "connections"
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridExtensions.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridExtensions.swift b/sdks/swift/Source/UsergridExtensions.swift
deleted file mode 100644
index 30ff3a7..0000000
--- a/sdks/swift/Source/UsergridExtensions.swift
+++ /dev/null
@@ -1,112 +0,0 @@
-//
-// UsergridExtensions.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 10/6/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-private let kUsergrid_Milliseconds_Per_Second = 1000
-
-/// Extension methods to help create and manipulate `NSDate` objects returned by Usergrid.
-public extension NSDate {
- /**
- Creates a new `NSDate` object with the given milliseconds.
-
- - parameter milliseconds: the milliseconds
-
- - returns: A new `NSDate` object.
- */
- public convenience init(milliseconds: String) {
- self.init(timeIntervalSince1970: (milliseconds as NSString).doubleValue / Double(kUsergrid_Milliseconds_Per_Second) )
- }
- /**
- Converts the `NSDate` object to milliseconds.
-
- - returns: The number of milliseconds corresponding to the date.
- */
- public func dateAsMilliseconds() -> Int {
- return Int(self.timeIntervalSince1970 * Double(kUsergrid_Milliseconds_Per_Second))
- }
- /**
- Converts the `NSDate` object to milliseconds and returns the value as a string.
-
- - returns: The number of milliseconds corresponding to the date as a string.
- */
- public func dateAsMillisecondsString() -> String {
- return NSDate.stringFromMilleseconds(self.dateAsMilliseconds())
- }
- /**
- Converts the number of milliseconds to a string.
-
- - parameter milliseconds: the milliseconds to convert
-
- - returns: The milliseconds as a string.
- */
- public static func stringFromMilleseconds(milliseconds:Int) -> String {
- return NSNumber(longLong: Int64(milliseconds)).stringValue
- }
- /**
- Converts the `NSDate` object to the corresponding UNIX time stamp as a string.
-
- - returns: The UNIX time stamp as a string.
- */
- public static func unixTimeStampString() -> String {
- return NSDate.stringFromMilleseconds(NSDate.nowAsMilliseconds())
- }
- /**
- Converts the `NSDate` object to the corresponding UNIX time stamp.
-
- - returns: The UNIX time stamp.
- */
- public static func unixTimeStamp() -> Int {
- return NSDate.nowAsMilliseconds()
- }
- /**
- Converts the current date to milliseconds.
-
- - returns: The milliseconds of the current date.
- */
- public static func nowAsMilliseconds() -> Int {
- var tv = timeval()
- let currentMillisecondTime = withUnsafeMutablePointer(&tv, { (t: UnsafeMutablePointer<timeval>) -> Int in
- gettimeofday(t, nil)
- return (Int(t.memory.tv_sec) * kUsergrid_Milliseconds_Per_Second) + (Int(t.memory.tv_usec) / kUsergrid_Milliseconds_Per_Second)
- })
- return currentMillisecondTime
- }
-}
-
-internal extension String {
- func isUuid() -> Bool {
- return (NSUUID(UUIDString: self) != nil) ? true : false
- }
-}
-
-internal extension Dictionary {
- mutating func update(other:Dictionary) {
- for (key,value) in other {
- self.updateValue(value, forKey:key)
- }
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridFileMetaData.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridFileMetaData.swift b/sdks/swift/Source/UsergridFileMetaData.swift
deleted file mode 100644
index 4908430..0000000
--- a/sdks/swift/Source/UsergridFileMetaData.swift
+++ /dev/null
@@ -1,114 +0,0 @@
-//
-// UsergridFileMetaData.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 10/6/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-/**
-`UsergridFileMetaData` is a helper class for dealing with reading `UsergridEntity` file meta data.
-*/
-public class UsergridFileMetaData : NSObject,NSCoding {
-
- internal static let FILE_METADATA = "file-metadata"
-
- // MARK: - Instance Properties -
-
- /// The eTag.
- public let eTag: String?
-
- /// The check sum.
- public let checkSum: String?
-
- /// The content type associated with the file data.
- public let contentType: String?
-
- /// The content length of the file data.
- public let contentLength: Int
-
- /// The last modified time stamp.
- public let lastModifiedTimeStamp: Int
-
- /// The `NSDate` object corresponding to the last modified time stamp.
- public let lastModifiedDate: NSDate?
-
- // MARK: - Initialization -
-
- /**
- Designated initializer for `UsergridFileMetaData` objects.
-
- - parameter fileMetaDataJSON: The file meta data JSON dictionary.
-
- - returns: A new instance of `UsergridFileMetaData`.
- */
- public init(fileMetaDataJSON:[String:AnyObject]) {
- self.eTag = fileMetaDataJSON["etag"] as? String
- self.checkSum = fileMetaDataJSON["checksum"] as? String
- self.contentType = fileMetaDataJSON["content-type"] as? String
- self.contentLength = fileMetaDataJSON["content-length"] as? Int ?? 0
- self.lastModifiedTimeStamp = fileMetaDataJSON["last-modified"] as? Int ?? 0
-
- if self.lastModifiedTimeStamp > 0 {
- self.lastModifiedDate = NSDate(milliseconds: self.lastModifiedTimeStamp.description)
- } else {
- self.lastModifiedDate = nil
- }
- }
-
- // MARK: - NSCoding -
-
- /**
- NSCoding protocol initializer.
-
- - parameter aDecoder: The decoder.
-
- - returns: A decoded `UsergridUser` object.
- */
- required public init?(coder aDecoder: NSCoder) {
- self.eTag = aDecoder.decodeObjectForKey("etag") as? String
- self.checkSum = aDecoder.decodeObjectForKey("checksum") as? String
- self.contentType = aDecoder.decodeObjectForKey("content-type") as? String
- self.contentLength = aDecoder.decodeIntegerForKey("content-length") ?? 0
- self.lastModifiedTimeStamp = aDecoder.decodeIntegerForKey("last-modified") ?? 0
-
- if self.lastModifiedTimeStamp > 0 {
- self.lastModifiedDate = NSDate(milliseconds: self.lastModifiedTimeStamp.description)
- } else {
- self.lastModifiedDate = nil
- }
- }
-
- /**
- NSCoding protocol encoder.
-
- - parameter aCoder: The encoder.
- */
- public func encodeWithCoder(aCoder: NSCoder) {
- aCoder.encodeObject(self.eTag, forKey: "etag")
- aCoder.encodeObject(self.checkSum, forKey: "checksum")
- aCoder.encodeObject(self.contentType, forKey: "content-type")
- aCoder.encodeInteger(self.contentLength, forKey: "content-length")
- aCoder.encodeInteger(self.lastModifiedTimeStamp, forKey: "last-modified")
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridKeychainHelpers.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridKeychainHelpers.swift b/sdks/swift/Source/UsergridKeychainHelpers.swift
deleted file mode 100644
index 4639832..0000000
--- a/sdks/swift/Source/UsergridKeychainHelpers.swift
+++ /dev/null
@@ -1,196 +0,0 @@
-//
-// UsergridKeychainHelpers.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 12/21/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-#if os(iOS) || os(tvOS) || os(watchOS)
-import UIKit
-#endif
-
-private let USERGRID_KEYCHAIN_NAME = "Usergrid"
-private let USERGRID_DEVICE_KEYCHAIN_SERVICE = "SharedDevice"
-private let USERGRID_CURRENT_USER_KEYCHAIN_SERVICE = "CurrentUser"
-
-private func usergridGenericKeychainItem() -> [String:AnyObject] {
- var keychainItem: [String:AnyObject] = [:]
- keychainItem[kSecClass as String] = kSecClassGenericPassword as String
- keychainItem[kSecAttrAccessible as String] = kSecAttrAccessibleAlways as String
- keychainItem[kSecAttrAccount as String] = USERGRID_KEYCHAIN_NAME
- return keychainItem
-}
-
-internal extension UsergridDevice {
-
- static func deviceKeychainItem() -> [String:AnyObject] {
- var keychainItem = usergridGenericKeychainItem()
- keychainItem[kSecAttrService as String] = USERGRID_DEVICE_KEYCHAIN_SERVICE
- return keychainItem
- }
-
- static func createNewDeviceKeychainUUID() -> String {
-
- #if os(watchOS) || os(OSX)
- let usergridUUID = NSUUID().UUIDString
- #elseif os(iOS) || os(tvOS)
- let usergridUUID = UIDevice.currentDevice().identifierForVendor?.UUIDString ?? NSUUID().UUIDString
- #endif
-
- return usergridUUID
- }
-
- private static func createNewSharedDevice() -> UsergridDevice {
- var deviceEntityDict = UsergridDevice.commonDevicePropertyDict()
- deviceEntityDict[UsergridEntityProperties.UUID.stringValue] = UsergridDevice.createNewDeviceKeychainUUID()
- let sharedDevice = UsergridDevice(type: UsergridDevice.DEVICE_ENTITY_TYPE, name: nil, propertyDict: deviceEntityDict)
- return sharedDevice
- }
-
- static func getOrCreateSharedDeviceFromKeychain() -> UsergridDevice {
- var queryAttributes = UsergridDevice.deviceKeychainItem()
- queryAttributes[kSecReturnData as String] = kCFBooleanTrue as Bool
- queryAttributes[kSecReturnAttributes as String] = kCFBooleanTrue as Bool
- var result: AnyObject?
- let status = withUnsafeMutablePointer(&result) { SecItemCopyMatching(queryAttributes, UnsafeMutablePointer($0)) }
- if status == errSecSuccess {
- if let resultDictionary = result as? NSDictionary {
- if let resultData = resultDictionary[kSecValueData as String] as? NSData {
- if let sharedDevice = NSKeyedUnarchiver.unarchiveObjectWithData(resultData) as? UsergridDevice {
- return sharedDevice
- } else {
- UsergridDevice.deleteSharedDeviceKeychainItem()
- }
- }
- }
- }
-
- let sharedDevice = UsergridDevice.createNewSharedDevice()
- UsergridDevice.saveSharedDeviceKeychainItem(sharedDevice)
- return sharedDevice
- }
-
-
- static func saveSharedDeviceKeychainItem(device:UsergridDevice) {
- var queryAttributes = UsergridDevice.deviceKeychainItem()
- queryAttributes[kSecReturnData as String] = kCFBooleanTrue as Bool
- queryAttributes[kSecReturnAttributes as String] = kCFBooleanTrue as Bool
-
- let sharedDeviceData = NSKeyedArchiver.archivedDataWithRootObject(device);
-
- if SecItemCopyMatching(queryAttributes,nil) == errSecSuccess // Do we need to update keychain item or add a new one.
- {
- let attributesToUpdate = [kSecValueData as String:sharedDeviceData]
- let updateStatus = SecItemUpdate(UsergridDevice.deviceKeychainItem(), attributesToUpdate)
- if updateStatus != errSecSuccess {
- print("Error updating shared device data to keychain!")
- }
- }
- else
- {
- var keychainItem = UsergridDevice.deviceKeychainItem()
- keychainItem[kSecValueData as String] = sharedDeviceData
- let status = SecItemAdd(keychainItem, nil)
- if status != errSecSuccess {
- print("Error adding shared device data to keychain!")
- }
- }
- }
-
- static func deleteSharedDeviceKeychainItem() {
- var queryAttributes = UsergridDevice.deviceKeychainItem()
- queryAttributes[kSecReturnData as String] = kCFBooleanFalse as Bool
- queryAttributes[kSecReturnAttributes as String] = kCFBooleanFalse as Bool
- if SecItemCopyMatching(queryAttributes,nil) == errSecSuccess {
- let deleteStatus = SecItemDelete(queryAttributes)
- if deleteStatus != errSecSuccess {
- print("Error deleting shared device data to keychain!")
- }
- }
- }
-}
-
-internal extension UsergridUser {
-
- static func userKeychainItem(client:UsergridClient) -> [String:AnyObject] {
- var keychainItem = usergridGenericKeychainItem()
- keychainItem[kSecAttrService as String] = USERGRID_CURRENT_USER_KEYCHAIN_SERVICE + "." + client.appId + "." + client.orgId
- return keychainItem
- }
-
- static func getCurrentUserFromKeychain(client:UsergridClient) -> UsergridUser? {
- var queryAttributes = UsergridUser.userKeychainItem(client)
- queryAttributes[kSecReturnData as String] = kCFBooleanTrue as Bool
- queryAttributes[kSecReturnAttributes as String] = kCFBooleanTrue as Bool
-
- var result: AnyObject?
- let status = withUnsafeMutablePointer(&result) { SecItemCopyMatching(queryAttributes, UnsafeMutablePointer($0)) }
- if status == errSecSuccess {
- if let resultDictionary = result as? NSDictionary {
- if let resultData = resultDictionary[kSecValueData as String] as? NSData {
- if let currentUser = NSKeyedUnarchiver.unarchiveObjectWithData(resultData) as? UsergridUser {
- return currentUser
- }
- }
- }
- }
- return nil
- }
-
- static func saveCurrentUserKeychainItem(client:UsergridClient, currentUser:UsergridUser) {
- var queryAttributes = UsergridUser.userKeychainItem(client)
- queryAttributes[kSecReturnData as String] = kCFBooleanTrue as Bool
- queryAttributes[kSecReturnAttributes as String] = kCFBooleanTrue as Bool
-
- if SecItemCopyMatching(queryAttributes,nil) == errSecSuccess // Do we need to update keychain item or add a new one.
- {
- let attributesToUpdate = [kSecValueData as String:NSKeyedArchiver.archivedDataWithRootObject(currentUser)]
- let updateStatus = SecItemUpdate(UsergridUser.userKeychainItem(client), attributesToUpdate)
- if updateStatus != errSecSuccess {
- print("Error updating current user data to keychain!")
- }
- }
- else
- {
- var keychainItem = UsergridUser.userKeychainItem(client)
- keychainItem[kSecValueData as String] = NSKeyedArchiver.archivedDataWithRootObject(currentUser)
- let status = SecItemAdd(keychainItem, nil)
- if status != errSecSuccess {
- print("Error adding current user data to keychain!")
- }
- }
- }
-
- static func deleteCurrentUserKeychainItem(client:UsergridClient) {
- var queryAttributes = UsergridUser.userKeychainItem(client)
- queryAttributes[kSecReturnData as String] = kCFBooleanFalse as Bool
- queryAttributes[kSecReturnAttributes as String] = kCFBooleanFalse as Bool
- if SecItemCopyMatching(queryAttributes,nil) == errSecSuccess {
- let deleteStatus = SecItemDelete(queryAttributes)
- if deleteStatus != errSecSuccess {
- print("Error deleting current user data to keychain!")
- }
- }
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridQuery.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridQuery.swift b/sdks/swift/Source/UsergridQuery.swift
deleted file mode 100644
index c2a7000..0000000
--- a/sdks/swift/Source/UsergridQuery.swift
+++ /dev/null
@@ -1,591 +0,0 @@
-//
-// UsergridQuery.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 7/22/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-/**
- `UsergridQuery` is builder class used to construct filtered requests to Usergrid.
-
- `UsergridQuery` objects are then passed to `UsergridClient` or `Usergrid` methods which support `UsergridQuery` as a parameter are .GET(), .PUT(), and .DELETE().
- */
-public class UsergridQuery : NSObject,NSCopying {
-
- // MARK: - Initialization -
-
- /**
- Desingated initializer for `UsergridQuery` objects.
-
- - parameter collectionName: The collection name or `type` of entities you want to query.
-
- - returns: A new instance of `UsergridQuery`.
- */
- public init(_ collectionName: String? = nil) {
- self.collectionName = collectionName
- }
-
- // MARK: - NSCopying -
-
- /**
- See the NSCopying protocol.
-
- - parameter zone: Ignored
-
- - returns: Returns a new instance that\u2019s a copy of the receiver.
- */
- public func copyWithZone(zone: NSZone) -> AnyObject {
- let queryCopy = UsergridQuery(self.collectionName)
- queryCopy.requirementStrings = NSArray(array:self.requirementStrings, copyItems: true) as! [String]
- queryCopy.urlTerms = NSArray(array:self.urlTerms, copyItems: true) as! [String]
- for (key,value) in self.orderClauses {
- queryCopy.orderClauses[key] = value
- }
- queryCopy.limit = self.limit
- queryCopy.cursor = self.cursor
- return queryCopy
- }
-
- // MARK: - Building -
-
- /**
- Constructs the string that should be appeneded to the end of the URL as a query.
-
- - parameter autoURLEncode: Automatically encode the constructed string.
-
- - returns: The constructed URL query sting.
- */
- public func build(autoURLEncode: Bool = true) -> String {
- return self.constructURLAppend(autoURLEncode)
- }
-
- // MARK: - Builder Methods -
-
- /**
- Contains. Query: where term contains 'val%'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func contains(term: String, value: String) -> Self { return self.containsWord(term, value: value) }
-
-
- /**
- Contains. Query: where term contains 'val%'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func containsString(term: String, value: String) -> Self { return self.containsWord(term, value: value) }
-
- /**
- Contains. Query: where term contains 'val%'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func containsWord(term: String, value: String) -> Self { return self.addRequirement(term + UsergridQuery.SPACE + UsergridQuery.CONTAINS + UsergridQuery.SPACE + ((value.isUuid()) ? UsergridQuery.EMPTY_STRING : UsergridQuery.APOSTROPHE) + value + ((value.isUuid()) ? UsergridQuery.EMPTY_STRING : UsergridQuery.APOSTROPHE)) }
-
- /**
- Sort ascending. Query:. order by term asc.
-
- - parameter term: The term.
-
- - returns: `Self`
- */
- public func ascending(term: String) -> Self { return self.asc(term) }
-
- /**
- Sort ascending. Query:. order by term asc.
-
- - parameter term: The term.
-
- - returns: `Self`
- */
- public func asc(term: String) -> Self { return self.sort(term, sortOrder: .Asc) }
-
- /**
- Sort descending. Query: order by term desc
-
- - parameter term: The term.
-
- - returns: `Self`
- */
- public func descending(term: String) -> Self { return self.desc(term) }
-
- /**
- Sort descending. Query: order by term desc
-
- - parameter term: The term.
-
- - returns: `Self`
- */
- public func desc(term: String) -> Self { return self.sort(term, sortOrder: .Desc) }
-
- /**
- Filter (or Equal-to). Query: where term = 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func filter(term: String, value: AnyObject) -> Self { return self.eq(term, value: value) }
-
- /**
- Equal-to. Query: where term = 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func equals(term: String, value: AnyObject) -> Self { return self.eq(term, value: value) }
-
- /**
- Equal-to. Query: where term = 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func eq(term: String, value: AnyObject) -> Self { return self.addOperationRequirement(term, operation:.Equal, value: value) }
-
- /**
- Greater-than. Query: where term > 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func greaterThan(term: String, value: AnyObject) -> Self { return self.gt(term, value: value) }
-
- /**
- Greater-than. Query: where term > 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func gt(term: String, value: AnyObject) -> Self { return self.addOperationRequirement(term, operation:.GreaterThan, value: value) }
-
- /**
- Greater-than-or-equal-to. Query: where term >= 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func greaterThanOrEqual(term: String, value: AnyObject) -> Self { return self.gte(term, value: value) }
-
- /**
- Greater-than-or-equal-to. Query: where term >= 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func gte(term: String, value: AnyObject) -> Self { return self.addOperationRequirement(term, operation:.GreaterThanEqualTo, value: value) }
-
- /**
- Less-than. Query: where term < 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func lessThan(term: String, value: AnyObject) -> Self { return self.lt(term, value: value) }
-
- /**
- Less-than. Query: where term < 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func lt(term: String, value: AnyObject) -> Self { return self.addOperationRequirement(term, operation:.LessThan, value: value) }
-
- /**
- Less-than-or-equal-to. Query: where term <= 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func lessThanOrEqual(term: String, value: AnyObject) -> Self { return self.lte(term, value: value) }
-
- /**
- Less-than-or-equal-to. Query: where term <= 'value'.
-
- - parameter term: The term.
- - parameter value: The value.
-
- - returns: `Self`
- */
- public func lte(term: String, value: AnyObject) -> Self { return self.addOperationRequirement(term, operation:.LessThanEqualTo, value: value) }
-
- /**
- Contains. Query: location within val of lat, long.
-
- - parameter distance: The distance from the latitude and longitude.
- - parameter latitude: The latitude.
- - parameter longitude: The longitude.
-
- - returns: `Self`
- */
- public func locationWithin(distance: Float, latitude: Float, longitude: Float) -> Self {
- return self.addRequirement(UsergridQuery.LOCATION + UsergridQuery.SPACE + UsergridQuery.WITHIN + UsergridQuery.SPACE + distance.description + UsergridQuery.SPACE + UsergridQuery.OF + UsergridQuery.SPACE + latitude.description + UsergridQuery.COMMA + longitude.description )
- }
-
- /**
- Or operation for conditional queries.
-
- - returns: `Self`
- */
- public func or() -> Self {
- if !self.requirementStrings.first!.isEmpty {
- self.requirementStrings.insert(UsergridQuery.OR, atIndex: 0)
- self.requirementStrings.insert(UsergridQuery.EMPTY_STRING, atIndex: 0)
- }
- return self
- }
-
- /**
- And operation for conditional queries.
-
- - returns: `Self`
- */
- public func and() -> Self {
- if !self.requirementStrings.first!.isEmpty {
- self.requirementStrings.insert(UsergridQuery.AND, atIndex: 0)
- self.requirementStrings.insert(UsergridQuery.EMPTY_STRING, atIndex: 0)
- }
- return self
- }
-
- /**
- Not operation for conditional queries.
-
- - returns: `Self`
- */
- public func not() -> Self {
- if !self.requirementStrings.first!.isEmpty {
- self.requirementStrings.insert(UsergridQuery.NOT, atIndex: 0)
- self.requirementStrings.insert(UsergridQuery.EMPTY_STRING, atIndex: 0)
- }
- return self
- }
-
- /**
- Sort. Query: order by term `sortOrder`
-
- - parameter term: The term.
- - parameter sortOrder: The order.
-
- - returns: `Self`
- */
- public func sort(term: String, sortOrder: UsergridQuerySortOrder) -> Self {
- self.orderClauses[term] = sortOrder
- return self
- }
-
- /**
- Sets the collection name.
-
- - parameter collectionName: The new collection name.
-
- - returns: `Self`
- */
- public func collection(collectionName: String) -> Self {
- self.collectionName = collectionName
- return self
- }
-
- /**
- Sets the collection name.
-
- - parameter type: The new collection name.
-
- - returns: `Self`
- */
- public func type(type: String) -> Self {
- self.collectionName = type
- return self
- }
-
- /**
- Sets the limit on the query. Default limit is 10.
-
- - parameter limit: The limit.
-
- - returns: `Self`
- */
- public func limit(limit: Int) -> Self {
- self.limit = limit
- return self
- }
-
- /**
- Adds a preconstructed query string as a requirement onto the query.
-
- - parameter value: The query string.
-
- - returns: `Self`
- */
- public func ql(value: String) -> Self {
- return self.addRequirement(value)
- }
-
- /**
- Sets the cursor of the query used internally by Usergrid's APIs.
-
- - parameter value: The cursor.
-
- - returns: `Self`
- */
- public func cursor(value: String?) -> Self {
- self.cursor = value
- return self
- }
-
- /**
- A special builder property that allows you to input a pre-defined query string. All builder properties will be ignored when this property is defined.
-
- - parameter value: The pre-defined query string.
-
- - returns: `Self`
- */
- public func fromString(value: String?) -> Self {
- self.fromStringValue = value
- return self
- }
-
- /**
- Adds a URL term that will be added next to the query string when constructing the URL append.
-
- - parameter term: The term.
- - parameter equalsValue: The value.
-
- - returns: `Self`
- */
- public func urlTerm(term: String, equalsValue: String) -> Self {
- if (term as NSString).isEqualToString(UsergridQuery.QL) {
- self.ql(equalsValue)
- } else {
- self.urlTerms.append(term + UsergridQueryOperator.Equal.stringValue + equalsValue)
- }
- return self
- }
-
- /**
- Adds a string requirement to the query.
-
- - parameter term: The term.
- - parameter operation: The operation.
- - parameter stringValue: The string value.
-
- - returns: `Self`
- */
- public func addOperationRequirement(term: String, operation: UsergridQueryOperator, stringValue: String) -> Self {
- return self.addOperationRequirement(term,operation:operation,value:stringValue)
- }
-
- /**
- Adds a integer requirement to the query.
-
- - parameter term: The term.
- - parameter operation: The operation.
- - parameter intValue: The integer value.
-
- - returns: `Self`
- */
- public func addOperationRequirement(term: String, operation: UsergridQueryOperator, intValue: Int) -> Self {
- return self.addOperationRequirement(term,operation:operation,value:intValue)
- }
-
- private func addRequirement(requirement: String) -> Self {
- var requirementString: String = self.requirementStrings.removeAtIndex(0)
- if !requirementString.isEmpty {
- requirementString += UsergridQuery.SPACE + UsergridQuery.AND + UsergridQuery.SPACE
- }
- requirementString += requirement
- self.requirementStrings.insert(requirementString, atIndex: 0)
- return self
- }
-
- private func addOperationRequirement(term: String, operation: UsergridQueryOperator, value: AnyObject) -> Self {
- if value is String {
- return self.addRequirement(term + UsergridQuery.SPACE + operation.stringValue + UsergridQuery.SPACE + ((value.description.isUuid()) ? UsergridQuery.EMPTY_STRING : UsergridQuery.APOSTROPHE) + value.description + ((value.description.isUuid()) ? UsergridQuery.EMPTY_STRING : UsergridQuery.APOSTROPHE) )
- } else {
- return self.addRequirement(term + UsergridQuery.SPACE + operation.stringValue + UsergridQuery.SPACE + value.description)
- }
- }
-
- private func constructOrderByString() -> String {
- var orderByString = UsergridQuery.EMPTY_STRING
- if !self.orderClauses.isEmpty {
- var combinedClausesArray: [String] = []
- for (key,value) in self.orderClauses {
- combinedClausesArray.append(key + UsergridQuery.SPACE + value.stringValue)
- }
- for index in 0..<combinedClausesArray.count {
- if index > 0 {
- orderByString += UsergridQuery.COMMA
- }
- orderByString += combinedClausesArray[index]
- }
- if !orderByString.isEmpty {
- orderByString = UsergridQuery.SPACE + UsergridQuery.ORDER_BY + UsergridQuery.SPACE + orderByString
- }
- }
- return orderByString
- }
-
- private func constructURLTermsString() -> String {
- return (self.urlTerms as NSArray).componentsJoinedByString(UsergridQuery.AMPERSAND)
- }
-
- private func constructRequirementString() -> String {
- var requirementsString = UsergridQuery.EMPTY_STRING
- var requirementStrings = self.requirementStrings
-
- // If the first requirement is empty lets remove it.
- if let firstRequirement = requirementStrings.first where firstRequirement.isEmpty {
- requirementStrings.removeFirst()
- }
-
- // If the first requirement now is a conditional separator then we should remove it so its not placed at the end of the constructed string.
- if let firstRequirement = requirementStrings.first where firstRequirement == UsergridQuery.OR || firstRequirement == UsergridQuery.NOT {
- requirementStrings.removeFirst()
- }
-
- requirementsString = (requirementStrings.reverse() as NSArray).componentsJoinedByString(UsergridQuery.SPACE)
- return requirementsString
- }
-
- private func constructURLAppend(autoURLEncode: Bool = true) -> String {
-
- if let fromString = self.fromStringValue {
- var requirementsString = fromString
- if autoURLEncode {
- if let encodedRequirementsString = fromString.stringByAddingPercentEncodingWithAllowedCharacters(NSCharacterSet.URLQueryAllowedCharacterSet()) {
- requirementsString = encodedRequirementsString
- }
- }
- return "\(UsergridQuery.QUESTION_MARK)\(UsergridQuery.QL)=\(requirementsString)"
- }
-
- var urlAppend = UsergridQuery.EMPTY_STRING
- if self.limit != UsergridQuery.LIMIT_DEFAULT {
- urlAppend += "\(UsergridQuery.LIMIT)=\(self.limit.description)"
- }
- let urlTermsString = self.constructURLTermsString()
- if !urlTermsString.isEmpty {
- if !urlAppend.isEmpty {
- urlAppend += UsergridQuery.AMPERSAND
- }
- urlAppend += urlTermsString
- }
- if let cursorString = self.cursor where !cursorString.isEmpty {
- if !urlAppend.isEmpty {
- urlAppend += UsergridQuery.AMPERSAND
- }
- urlAppend += "\(UsergridQuery.CURSOR)=\(cursorString)"
- }
-
- var requirementsString = UsergridQuery.SELECT_ALL + UsergridQuery.SPACE + self.constructRequirementString()
- let orderByString = self.constructOrderByString()
- if !orderByString.isEmpty {
- requirementsString += orderByString
- }
- if !requirementsString.isEmpty {
- if autoURLEncode {
- if let encodedRequirementsString = requirementsString.stringByAddingPercentEncodingWithAllowedCharacters(NSCharacterSet.URLQueryAllowedCharacterSet()) {
- requirementsString = encodedRequirementsString
- }
- }
- if !urlAppend.isEmpty {
- urlAppend += UsergridQuery.AMPERSAND
- }
- urlAppend += "\(UsergridQuery.QL)=\(requirementsString)"
- }
-
- if !urlAppend.isEmpty {
- urlAppend = "\(UsergridQuery.QUESTION_MARK)\(urlAppend)"
- }
- return urlAppend
- }
-
- private(set) var collectionName: String? = nil
- private(set) var cursor: String? = nil
- private(set) var limit: Int = UsergridQuery.LIMIT_DEFAULT
-
- private(set) var fromStringValue: String? = nil
- private(set) var requirementStrings: [String] = [UsergridQuery.EMPTY_STRING]
- private(set) var orderClauses: [String:UsergridQuerySortOrder] = [:]
- private(set) var urlTerms: [String] = []
-
- private static let LIMIT_DEFAULT = 10
- private static let AMPERSAND = "&"
- private static let AND = "and"
- private static let APOSTROPHE = "'"
- private static let COMMA = ","
- private static let CONTAINS = "contains"
- private static let CURSOR = "cursor"
- private static let EMPTY_STRING = ""
- private static let IN = "in"
- private static let LIMIT = "limit"
- private static let LOCATION = "location";
- private static let NOT = "not"
- private static let OF = "of"
- private static let OR = "or"
- private static let ORDER_BY = "order by"
- private static let QL = "ql"
- private static let QUESTION_MARK = "?"
- private static let SELECT_ALL = "select *"
- private static let SPACE = " "
- private static let WITHIN = "within"
-
- internal static let ASC = "asc"
- internal static let DESC = "desc"
- internal static let EQUAL = "="
- internal static let GREATER_THAN = ">"
- internal static let GREATER_THAN_EQUAL_TO = ">="
- internal static let LESS_THAN = "<"
- internal static let LESS_THAN_EQUAL_TO = "<="
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridRequest.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridRequest.swift b/sdks/swift/Source/UsergridRequest.swift
deleted file mode 100644
index 0a651e2..0000000
--- a/sdks/swift/Source/UsergridRequest.swift
+++ /dev/null
@@ -1,245 +0,0 @@
-//
-// UsergridRequest.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 1/12/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-/**
- The UsergridRequest class incapsulates the properties that all requests made by the SDK have in common.
-
- This class is also functions to create `NSURLRequest` objects based on the properties of the class.
-*/
-public class UsergridRequest : NSObject {
-
- // MARK: - Instance Properties -
-
- /// The HTTP method.
- public let method: UsergridHttpMethod
-
- /// The base URL.
- public let baseUrl: String
-
- /// The paths to append to the base URL.
- public let paths: [String]?
-
- /// The query to append to the URL.
- public let query: UsergridQuery?
-
- /// The auth that will be used.
- public let auth: UsergridAuth?
-
- /// The headers to add to the request.
- public let headers: [String:String]?
-
- /// The JSON body that will be set on the request. Can be either a valid JSON object or NSData.
- public let jsonBody: AnyObject?
-
- /// The query params that will be set on the request.
- public let queryParams: [String:String]?
-
- // MARK: - Initialization -
-
- /**
- The designated initializer for `UsergridRequest` objects.
-
- - parameter method: The HTTP method.
- - parameter baseUrl: The base URL.
- - parameter paths: The optional paths to append to the base URL.
- - parameter query: The optional query to append to the URL.
- - parameter auth: The optional `UsergridAuth` that will be used in the Authorization header.
- - parameter headers: The optional headers.
- - parameter jsonBody: The optional JSON body. Can be either a valid JSON object or NSData.
- - parameter queryParams: The optional query params to be appended to the request url.
-
- - returns: A new instance of `UsergridRequest`.
- */
- public init(method:UsergridHttpMethod,
- baseUrl:String,
- paths:[String]? = nil,
- query:UsergridQuery? = nil,
- auth:UsergridAuth? = nil,
- headers:[String:String]? = nil,
- jsonBody:AnyObject? = nil,
- queryParams:[String:String]? = nil) {
- self.method = method
- self.baseUrl = baseUrl
- self.paths = paths
- self.auth = auth
- self.headers = headers
- self.query = query
- self.queryParams = queryParams
- if let body = jsonBody where (body is NSData || NSJSONSerialization.isValidJSONObject(body)) {
- self.jsonBody = body
- } else {
- self.jsonBody = nil
- }
- }
-
- // MARK: - Instance Methods -
-
- /**
- Constructs a `NSURLRequest` object with this objects instance properties.
-
- - returns: An initialized and configured `NSURLRequest` object.
- */
- public func buildNSURLRequest() -> NSURLRequest {
- let request = NSMutableURLRequest(URL: self.buildURL())
- request.HTTPMethod = self.method.stringValue
- self.applyHeaders(request)
- self.applyBody(request)
- self.applyAuth(request)
- return request
- }
-
- private func buildURL() -> NSURL {
- var constructedURLString = self.baseUrl
- if let appendingPaths = self.paths {
- for pathToAppend in appendingPaths {
- if let encodedPath = pathToAppend.stringByAddingPercentEncodingWithAllowedCharacters(NSCharacterSet.URLPathAllowedCharacterSet()) {
- constructedURLString = "\(constructedURLString)\(UsergridRequest.FORWARD_SLASH)\(encodedPath)"
- }
- }
- }
- if let queryToAppend = self.query {
- let appendFromQuery = queryToAppend.build()
- if !appendFromQuery.isEmpty {
- constructedURLString = "\(constructedURLString)\(UsergridRequest.FORWARD_SLASH)\(appendFromQuery)"
- }
- }
- if let queryParams = self.queryParams {
- if let components = NSURLComponents(string: constructedURLString) {
- components.queryItems = components.queryItems ?? []
- for (key, value) in queryParams {
- let q: NSURLQueryItem = NSURLQueryItem(name: key, value: value)
- components.queryItems!.append(q)
- }
- constructedURLString = components.string!
- }
- }
- return NSURL(string:constructedURLString)!
- }
-
- private func applyHeaders(request:NSMutableURLRequest) {
- if let httpHeaders = self.headers {
- for (key,value) in httpHeaders {
- request.setValue(value, forHTTPHeaderField: key)
- }
- }
- }
-
- private func applyBody(request:NSMutableURLRequest) {
- if let jsonBody = self.jsonBody, httpBody = UsergridRequest.jsonBodyToData(jsonBody) {
- request.HTTPBody = httpBody
- request.setValue(String(format: "%lu", httpBody.length), forHTTPHeaderField: UsergridRequest.CONTENT_LENGTH)
- }
- }
-
- private func applyAuth(request:NSMutableURLRequest) {
- if let usergridAuth = self.auth {
- if usergridAuth.isValid, let accessToken = usergridAuth.accessToken {
- request.setValue("\(UsergridRequest.BEARER) \(accessToken)", forHTTPHeaderField: UsergridRequest.AUTHORIZATION)
- }
- }
- }
-
- private static func jsonBodyToData(jsonBody:AnyObject) -> NSData? {
- if let jsonBodyAsNSData = jsonBody as? NSData {
- return jsonBodyAsNSData
- } else {
- var jsonBodyAsNSData: NSData? = nil
- do { jsonBodyAsNSData = try NSJSONSerialization.dataWithJSONObject(jsonBody, options: NSJSONWritingOptions(rawValue: 0)) }
- catch { print(error) }
- return jsonBodyAsNSData
- }
- }
-
- private static let AUTHORIZATION = "Authorization"
- private static let ACCESS_TOKEN = "access_token"
- private static let APPLICATION_JSON = "application/json; charset=utf-8"
- private static let BEARER = "Bearer"
- private static let CONTENT_LENGTH = "Content-Length"
- private static let CONTENT_TYPE = "Content-Type"
- private static let FORWARD_SLASH = "/"
-
- static let JSON_CONTENT_TYPE_HEADER = [UsergridRequest.CONTENT_TYPE:UsergridRequest.APPLICATION_JSON]
-}
-
-/**
- The `UsergridRequest` sub class which is used for uploading assets.
- */
-public class UsergridAssetUploadRequest: UsergridRequest {
-
- // MARK: - Instance Properties -
-
- /// The asset to use for uploading.
- public let asset: UsergridAsset
-
- /// A constructed multipart http body for requests to upload.
- public var multiPartHTTPBody: NSData {
- let httpBodyString = UsergridAssetUploadRequest.MULTIPART_START +
- "\(UsergridAssetUploadRequest.CONTENT_DISPOSITION):\(UsergridAssetUploadRequest.FORM_DATA); name=file; filename=\(self.asset.filename)\r\n" +
- "\(UsergridRequest.CONTENT_TYPE): \(self.asset.contentType)\r\n\r\n" as NSString
-
- let httpBody = NSMutableData()
- httpBody.appendData(httpBodyString.dataUsingEncoding(NSUTF8StringEncoding)!)
- httpBody.appendData(self.asset.data)
- httpBody.appendData(UsergridAssetUploadRequest.MULTIPART_END.dataUsingEncoding(NSUTF8StringEncoding)!)
-
- return httpBody
- }
-
- // MARK: - Initialization -
-
- /**
- The designated initializer for `UsergridAssetUploadRequest` objects.
-
- - parameter baseUrl: The base URL.
- - parameter paths: The optional paths to append to the base URL.
- - parameter auth: The optional `UsergridAuth` that will be used in the Authorization header.
- - parameter asset: The asset to upload.
-
- - returns: A new instance of `UsergridRequest`.
- */
- public init(baseUrl:String,
- paths:[String]? = nil,
- auth:UsergridAuth? = nil,
- asset:UsergridAsset) {
- self.asset = asset
- super.init(method: .Put, baseUrl: baseUrl, paths: paths, auth: auth)
- }
-
- private override func applyHeaders(request: NSMutableURLRequest) {
- super.applyHeaders(request)
- request.setValue(UsergridAssetUploadRequest.ASSET_UPLOAD_CONTENT_HEADER, forHTTPHeaderField: UsergridRequest.CONTENT_TYPE)
- request.setValue(String(format: "%lu", self.multiPartHTTPBody.length), forHTTPHeaderField: UsergridRequest.CONTENT_LENGTH)
- }
-
- private static let ASSET_UPLOAD_BOUNDARY = "usergrid-asset-upload-boundary"
- private static let ASSET_UPLOAD_CONTENT_HEADER = "multipart/form-data; boundary=\(UsergridAssetUploadRequest.ASSET_UPLOAD_BOUNDARY)"
- private static let CONTENT_DISPOSITION = "Content-Disposition"
- private static let MULTIPART_START = "--\(UsergridAssetUploadRequest.ASSET_UPLOAD_BOUNDARY)\r\n"
- private static let MULTIPART_END = "\r\n--\(UsergridAssetUploadRequest.ASSET_UPLOAD_BOUNDARY)--\r\n" as NSString
- private static let FORM_DATA = "form-data"
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridRequestManager.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridRequestManager.swift b/sdks/swift/Source/UsergridRequestManager.swift
deleted file mode 100644
index 46a4213..0000000
--- a/sdks/swift/Source/UsergridRequestManager.swift
+++ /dev/null
@@ -1,176 +0,0 @@
-//
-// UsergridRequestManager.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/22/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-final class UsergridRequestManager {
-
- unowned let client: UsergridClient
-
- let session: NSURLSession
-
- var sessionDelegate : UsergridSessionDelegate {
- return session.delegate as! UsergridSessionDelegate
- }
-
- init(client:UsergridClient) {
- self.client = client
-
- let config = NSURLSessionConfiguration.defaultSessionConfiguration()
-
- #if os(tvOS)
- config.HTTPAdditionalHeaders = ["User-Agent": "usergrid-tvOS/v\(UsergridSDKVersion)"]
- #elseif os(iOS)
- config.HTTPAdditionalHeaders = ["User-Agent": "usergrid-ios/v\(UsergridSDKVersion)"]
- #elseif os(watchOS)
- config.HTTPAdditionalHeaders = ["User-Agent": "usergrid-watchOS/v\(UsergridSDKVersion)"]
- #elseif os(OSX)
- config.HTTPAdditionalHeaders = ["User-Agent": "usergrid-osx/v\(UsergridSDKVersion)"]
- #endif
-
- self.session = NSURLSession(configuration: config,
- delegate: UsergridSessionDelegate(),
- delegateQueue: nil)
- }
-
- deinit {
- session.invalidateAndCancel()
- }
-
- func performRequest(request:UsergridRequest, completion:UsergridResponseCompletion?) {
- session.dataTaskWithRequest(request.buildNSURLRequest()) { [weak self] (data, response, error) -> Void in
- let response = UsergridResponse(client:self?.client, data: data, response: response as? NSHTTPURLResponse, error: error)
- dispatch_async(dispatch_get_main_queue()) {
- completion?(response: response)
- }
- }.resume()
- }
-}
-
-
-// MARK: - Authentication -
-extension UsergridRequestManager {
-
- static func getTokenAndExpiryFromResponseJSON(jsonDict:[String:AnyObject]) -> (token:String?,expiry:NSDate?) {
- var token: String? = nil
- var expiry: NSDate? = nil
- if let accessToken = jsonDict["access_token"] as? String {
- token = accessToken
- }
- if let expiresIn = jsonDict["expires_in"] as? Int {
- let expiresInAdjusted = expiresIn - 5000
- expiry = NSDate(timeIntervalSinceNow: NSTimeInterval(expiresInAdjusted))
- }
- return (token,expiry)
- }
-
- func performUserAuthRequest(userAuth:UsergridUserAuth, request:UsergridRequest, completion:UsergridUserAuthCompletionBlock?) {
- session.dataTaskWithRequest(request.buildNSURLRequest()) { (data, response, error) -> Void in
- let dataAsJSON = try! NSJSONSerialization.JSONObjectWithData(data!, options: NSJSONReadingOptions.MutableContainers)
-
- var createdUser: UsergridUser? = nil
- var responseError: UsergridResponseError? = nil
-
- if let jsonDict = dataAsJSON as? [String:AnyObject] {
- let tokenAndExpiry = UsergridRequestManager.getTokenAndExpiryFromResponseJSON(jsonDict)
- userAuth.accessToken = tokenAndExpiry.token
- userAuth.expiry = tokenAndExpiry.expiry
-
- if let userDict = jsonDict[UsergridUser.USER_ENTITY_TYPE] as? [String:AnyObject] {
- if let newUser = UsergridEntity.entity(jsonDict: userDict) as? UsergridUser {
- newUser.auth = userAuth
- createdUser = newUser
- }
- }
- if createdUser == nil {
- responseError = UsergridResponseError(jsonDictionary: jsonDict) ?? UsergridResponseError(errorName: "Auth Failed.", errorDescription: "Error Description: \(error?.localizedDescription).")
- }
- } else {
- responseError = UsergridResponseError(errorName: "Auth Failed.", errorDescription: "Error Description: \(error?.localizedDescription).")
- }
-
- dispatch_async(dispatch_get_main_queue()) {
- completion?(auth: userAuth, user: createdUser, error: responseError)
- }
- }.resume()
- }
-
- func performAppAuthRequest(appAuth: UsergridAppAuth, request: UsergridRequest, completion: UsergridAppAuthCompletionBlock?) {
- session.dataTaskWithRequest(request.buildNSURLRequest()) { (data, response, error) -> Void in
- let dataAsJSON = try! NSJSONSerialization.JSONObjectWithData(data!, options: NSJSONReadingOptions.MutableContainers)
-
- var responseError: UsergridResponseError? = nil
-
- if let jsonDict = dataAsJSON as? [String:AnyObject] {
- let tokenAndExpiry = UsergridRequestManager.getTokenAndExpiryFromResponseJSON(jsonDict)
- appAuth.accessToken = tokenAndExpiry.token
- appAuth.expiry = tokenAndExpiry.expiry
- } else {
- responseError = UsergridResponseError(errorName: "Auth Failed.", errorDescription: "Error Description: \(error?.localizedDescription).")
- }
-
- dispatch_async(dispatch_get_main_queue()) {
- completion?(auth: appAuth, error: responseError)
- }
- }.resume()
- }
-}
-
-// MARK: - Asset Management -
-extension UsergridRequestManager {
-
- func performAssetDownload(contentType:String, usergridRequest:UsergridRequest, progress: UsergridAssetRequestProgress? = nil, completion:UsergridAssetDownloadCompletion? = nil) {
- let downloadTask = session.downloadTaskWithRequest(usergridRequest.buildNSURLRequest())
- let requestWrapper = UsergridAssetRequestWrapper(session: self.session, sessionTask: downloadTask, progress: progress) { (request) -> Void in
- var asset: UsergridAsset? = nil
- var responseError: UsergridResponseError? = nil
-
- if let assetData = request.responseData where assetData.length > 0 {
- asset = UsergridAsset(data: assetData, contentType: contentType)
- } else {
- responseError = UsergridResponseError(errorName: "Download Failed.", errorDescription: "Downloading asset failed. No data was recieved.")
- }
-
- dispatch_async(dispatch_get_main_queue()) {
- completion?(asset: asset, error: responseError)
- }
- }
- self.sessionDelegate.addRequestDelegate(requestWrapper.sessionTask, requestWrapper:requestWrapper)
- requestWrapper.sessionTask.resume()
- }
-
- func performAssetUpload(usergridRequest:UsergridAssetUploadRequest, progress:UsergridAssetRequestProgress? = nil, completion: UsergridAssetUploadCompletion? = nil) {
- let uploadTask = session.uploadTaskWithRequest(usergridRequest.buildNSURLRequest(), fromData: usergridRequest.multiPartHTTPBody)
- let requestWrapper = UsergridAssetRequestWrapper(session: self.session, sessionTask: uploadTask, progress: progress) { [weak self] (request) -> Void in
- let response = UsergridResponse(client: self?.client, data: request.responseData, response: request.response as? NSHTTPURLResponse, error: request.error)
- dispatch_async(dispatch_get_main_queue()) {
- completion?(asset: usergridRequest.asset, response: response)
- }
- }
- self.sessionDelegate.addRequestDelegate(requestWrapper.sessionTask, requestWrapper:requestWrapper)
- requestWrapper.sessionTask.resume()
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridResponse.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridResponse.swift b/sdks/swift/Source/UsergridResponse.swift
deleted file mode 100644
index b9e58ec..0000000
--- a/sdks/swift/Source/UsergridResponse.swift
+++ /dev/null
@@ -1,203 +0,0 @@
-//
-// UsergridResponse.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/2/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-/// The completion block used in for most `UsergridClient` requests.
-public typealias UsergridResponseCompletion = (response: UsergridResponse) -> Void
-
-/**
-`UsergridResponse` is the core class that handles both successful and unsuccessful HTTP responses from Usergrid.
-
-If a request is successful, any entities returned in the response will be automatically parsed into `UsergridEntity` objects and pushed to the `entities` property.
-
-If a request fails, the `UsergridResponseError.error` property will contain information about the problem encountered.
-*/
-public class UsergridResponse: NSObject {
-
- // MARK: - Instance Properties -
-
- /// The client that was responsible for the request.
- public weak var client: UsergridClient?
-
- /// The raw response JSON.
- internal(set) public var responseJSON: [String:AnyObject]?
-
- /// The query used on the request.
- internal(set) public var query: UsergridQuery?
-
- /// The cursor from the response.
- internal(set) public var cursor: String?
-
- /// The entities created from the response JSON.
- internal(set) public var entities: [UsergridEntity]?
-
- /// The response headers.
- internal(set) public var headers: [String:String]?
-
- /// The response status code.
- internal(set) public var statusCode: Int?
-
- /// The error object containing error information if one occurred.
- internal(set) public var error: UsergridResponseError?
-
- /// Returns true if the HTTP status code from the response is less than 400.
- public var ok : Bool {
- var isOk = false
- if let statusCode = self.statusCode {
- isOk = (statusCode < 400)
- }
- return isOk
- }
-
- /// The count of `entities`.
- public var count: Int { return self.entities?.count ?? 0 }
-
- /// The first entity in `entities`.
- public var first: UsergridEntity? { return self.entities?.first }
-
- /// The last entity in `entities`.
- public var last: UsergridEntity? { return self.entities?.last }
-
- /// The first entity in `entities`.
- public var entity: UsergridEntity? { return self.first }
-
- /// The `UsergridUser` entity.
- public var user: UsergridUser? { return self.entities?.first as? UsergridUser }
-
- /// An array of `UsergridUser` entities.
- public var users: [UsergridUser]? { return self.entities as? [UsergridUser] }
-
- /// Does the response have a cursor.
- public var hasNextPage: Bool { return self.cursor != nil }
-
- /// The string value.
- public var stringValue : String {
- if let responseJSON = self.responseJSON {
- return NSString(data: try! NSJSONSerialization.dataWithJSONObject(responseJSON, options: .PrettyPrinted), encoding: NSUTF8StringEncoding) as? String ?? ""
- } else {
- return error?.description ?? ""
- }
- }
-
- /// The description.
- public override var description : String {
- return "Response Description: \(stringValue)."
- }
-
- /// The debug description.
- public override var debugDescription : String {
- return "Properties of Entity: \(stringValue)."
- }
-
- // MARK: - Initialization -
-
- /**
- Designated initializer for `UsergridResponse` objects that contain errors.
-
- These types of responses are usually created because request conditions are not met.
-
- - parameter client: The client responsible for the request.
- - parameter errorName: The error name.
- - parameter errorDescription: The error description.
-
- - returns: A new instance of `UsergridResponse`.
- */
- public init(client: UsergridClient?, errorName: String, errorDescription: String) {
- self.client = client
- self.error = UsergridResponseError(errorName: errorName, errorDescription: errorDescription, exception: nil)
- }
-
- /**
- Designated initializer for `UsergridResponse` objects finished but still may contain errors.
-
- - parameter client: The client responsible for the request.
- - parameter data: The response data.
- - parameter response: The `NSHTTPURLResponse` object.
- - parameter error: The `NSError` object.
- - parameter query: The query when making the request.
-
- - returns: A new instance of `UsergridResponse`.
- */
- public init(client:UsergridClient?, data:NSData?, response:NSHTTPURLResponse?, error:NSError?, query:UsergridQuery? = nil) {
- self.client = client
- self.statusCode = response?.statusCode
- self.headers = response?.allHeaderFields as? [String:String]
-
- if let sessionError = error {
- self.error = UsergridResponseError(errorName: sessionError.domain, errorDescription: sessionError.localizedDescription)
- }
-
- if let responseQuery = query {
- self.query = responseQuery.copy() as? UsergridQuery
- }
-
- if let jsonData = data {
- do {
- let dataAsJSON = try NSJSONSerialization.JSONObjectWithData(jsonData, options: NSJSONReadingOptions.MutableContainers)
- if let jsonDict = dataAsJSON as? [String:AnyObject] {
- self.responseJSON = jsonDict
- if let responseError = UsergridResponseError(jsonDictionary: jsonDict) {
- self.error = responseError
- } else {
- if let entitiesJSONArray = jsonDict[UsergridResponse.ENTITIES] as? [[String:AnyObject]] where entitiesJSONArray.count > 0 {
- self.entities = UsergridEntity.entities(jsonArray: entitiesJSONArray)
- }
- if let cursor = jsonDict[UsergridResponse.CURSOR] as? String where !cursor.isEmpty {
- self.cursor = cursor
- }
- }
- }
- } catch {
- print(error)
- }
- }
- }
-
- // MARK: - Instance Methods -
-
- /**
- Attempts to load the next page of `UsergridEntity` objects.
-
- This requires a `cursor` to be valid as well as a `path` key within the response JSON.
-
- - parameter completion: The completion block that is called once the request for the next page has finished.
- */
- public func loadNextPage(completion: UsergridResponseCompletion) {
- if self.hasNextPage, let type = (self.responseJSON?["path"] as? NSString)?.lastPathComponent {
- if let query = self.query?.copy() as? UsergridQuery {
- self.client?.GET(query.cursor(self.cursor), queryCompletion:completion)
- } else {
- self.client?.GET(UsergridQuery(type).cursor(self.cursor), queryCompletion:completion)
- }
- } else {
- completion(response: UsergridResponse(client: self.client, errorName: "No next page.", errorDescription: "No next page was found."))
- }
- }
-
- static let CURSOR = "cursor"
- static let ENTITIES = "entities"
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridResponseError.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridResponseError.swift b/sdks/swift/Source/UsergridResponseError.swift
deleted file mode 100644
index eda8a30..0000000
--- a/sdks/swift/Source/UsergridResponseError.swift
+++ /dev/null
@@ -1,90 +0,0 @@
-//
-// UsergridResponseError.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 1/8/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-/// A standard error object that contains details about a request failure.
-public class UsergridResponseError: NSObject {
-
- // MARK: - Instance Properties -
-
- /// The error's name.
- public let errorName : String
-
- /// The error's description.
- public let errorDescription: String
-
- /// The exception.
- public var exception: String?
-
- /// The description.
- public override var description : String {
- return "Error Name: \(errorName). Error Description: \(errorDescription). Exception: \(exception)."
- }
-
- /// The debug description.
- public override var debugDescription : String {
- return "Error Name: \(errorName). Error Description: \(errorDescription). Exception: \(exception)."
- }
-
- // MARK: - Initialization -
-
- /**
- Designated initializer for `UsergridResponseError`.
-
- - parameter errorName: The error's name.
- - parameter errorDescription: The error's description.
- - parameter exception: The exception.
-
- - returns: A new instance of `UsergridResponseError`
- */
- public init(errorName:String, errorDescription:String, exception:String? = nil) {
- self.errorName = errorName
- self.errorDescription = errorDescription
- self.exception = exception
- }
-
- /**
- Convenience initializer for `UsergridResponseError` that determines if the given `jsonDictionary` contains an error.
-
- - parameter jsonDictionary: The JSON dictionary that may contain error information.
-
- - returns: A new instance of `UsergridResponseError` if the JSON dictionary did indeed contain error information.
- */
- public convenience init?(jsonDictionary:[String:AnyObject]) {
- if let errorName = jsonDictionary[USERGRID_ERROR] as? String,
- errorDescription = jsonDictionary[USERGRID_ERROR_DESCRIPTION] as? String {
- self.init(errorName:errorName,errorDescription:errorDescription,exception:jsonDictionary[USERGRID_EXCEPTION] as? String)
- } else {
- self.init(errorName:"",errorDescription:"")
- return nil
- }
- }
-}
-
-let USERGRID_ERROR = "error"
-let USERGRID_ERROR_DESCRIPTION = "error_description"
-let USERGRID_EXCEPTION = "exception"
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridSDK.h
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridSDK.h b/sdks/swift/Source/UsergridSDK.h
deleted file mode 100644
index be9da27..0000000
--- a/sdks/swift/Source/UsergridSDK.h
+++ /dev/null
@@ -1,37 +0,0 @@
-//
-// UsergridSDK.h
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/30/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-#import <UIKit/UIKit.h>
-
-//! Project version number for UsergridSDK.
-FOUNDATION_EXPORT double UsergridSDKVersionNumber;
-
-//! Project version string for UsergridSDK.
-FOUNDATION_EXPORT const unsigned char UsergridSDKVersionString[];
-
-// In this header, you should import all the public headers of your framework using statements like #import <UsergridSDK/PublicHeader.h>
-
-
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridSessionDelegate.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridSessionDelegate.swift b/sdks/swift/Source/UsergridSessionDelegate.swift
deleted file mode 100644
index cb36fb7..0000000
--- a/sdks/swift/Source/UsergridSessionDelegate.swift
+++ /dev/null
@@ -1,90 +0,0 @@
-//
-// UsergridSessionDelegate.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/30/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-final class UsergridSessionDelegate: NSObject {
-
- private var requestDelegates: [Int:UsergridAssetRequestWrapper] = [:]
-
- func addRequestDelegate(task:NSURLSessionTask,requestWrapper:UsergridAssetRequestWrapper) {
- requestDelegates[task.taskIdentifier] = requestWrapper
- }
-
- func removeRequestDelegate(task:NSURLSessionTask) {
- requestDelegates[task.taskIdentifier] = nil
- }
-}
-
-extension UsergridSessionDelegate : NSURLSessionTaskDelegate {
-
- func URLSession(session: NSURLSession, task: NSURLSessionTask, didSendBodyData bytesSent: Int64, totalBytesSent: Int64, totalBytesExpectedToSend: Int64) {
- if let progressBlock = requestDelegates[task.taskIdentifier]?.progress {
- progressBlock(bytesFinished:totalBytesSent, bytesExpected: totalBytesExpectedToSend)
- }
- }
-
- func URLSession(session: NSURLSession, task: NSURLSessionTask, didCompleteWithError error: NSError?) {
- if let requestWrapper = requestDelegates[task.taskIdentifier] {
- requestWrapper.error = error
- requestWrapper.completion(requestWrapper: requestWrapper)
- }
- self.removeRequestDelegate(task)
- }
-}
-
-extension UsergridSessionDelegate : NSURLSessionDataDelegate {
-
- func URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveResponse response: NSURLResponse, completionHandler: (NSURLSessionResponseDisposition) -> Void) {
- if let requestWrapper = requestDelegates[dataTask.taskIdentifier] {
- requestWrapper.response = response
- }
- completionHandler(NSURLSessionResponseDisposition.Allow)
- }
-
- func URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveData data: NSData) {
- if let requestWrapper = requestDelegates[dataTask.taskIdentifier] {
- let mutableData = requestWrapper.responseData != nil ? NSMutableData(data: requestWrapper.responseData!) : NSMutableData()
- mutableData.appendData(data)
- requestWrapper.responseData = mutableData
- }
- }
-}
-
-extension UsergridSessionDelegate : NSURLSessionDownloadDelegate {
-
- func URLSession(session: NSURLSession, downloadTask: NSURLSessionDownloadTask, didWriteData bytesWritten: Int64, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64) {
- if let progressBlock = requestDelegates[downloadTask.taskIdentifier]?.progress {
- progressBlock(bytesFinished:totalBytesWritten, bytesExpected: totalBytesExpectedToWrite)
- }
- }
-
- func URLSession(session: NSURLSession, downloadTask: NSURLSessionDownloadTask, didFinishDownloadingToURL location: NSURL) {
- if let requestWrapper = requestDelegates[downloadTask.taskIdentifier] {
- requestWrapper.responseData = NSData(contentsOfURL: location)!
- }
- }
-}
\ No newline at end of file
[18/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridFileMetaData.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridFileMetaData.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridFileMetaData.html
deleted file mode 100644
index 1cc8ccf..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridFileMetaData.html
+++ /dev/null
@@ -1,532 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridFileMetaData 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/UsergridFileMetaData" class="dashAnchor"></a>
- <a title="UsergridFileMetaData 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" />
- UsergridFileMetaData 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>UsergridFileMetaData</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridFileMetaData</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span><span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridFileMetaData</code> is a helper class for dealing with reading <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> file meta data.</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:vC11UsergridSDK20UsergridFileMetaData4eTagGSqSS_"></a>
- <a name="//apple_ref/swift/Property/eTag" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData4eTagGSqSS_">eTag</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The eTag.</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">eTag</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:vC11UsergridSDK20UsergridFileMetaData8checkSumGSqSS_"></a>
- <a name="//apple_ref/swift/Property/checkSum" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData8checkSumGSqSS_">checkSum</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The check sum.</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">checkSum</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:vC11UsergridSDK20UsergridFileMetaData11contentTypeGSqSS_"></a>
- <a name="//apple_ref/swift/Property/contentType" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData11contentTypeGSqSS_">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 associated with the file 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">contentType</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:vC11UsergridSDK20UsergridFileMetaData13contentLengthSi"></a>
- <a name="//apple_ref/swift/Property/contentLength" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData13contentLengthSi">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 file 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">contentLength</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK20UsergridFileMetaData21lastModifiedTimeStampSi"></a>
- <a name="//apple_ref/swift/Property/lastModifiedTimeStamp" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData21lastModifiedTimeStampSi">lastModifiedTimeStamp</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The last modified time stamp.</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">lastModifiedTimeStamp</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK20UsergridFileMetaData16lastModifiedDateGSqCSo6NSDate_"></a>
- <a name="//apple_ref/swift/Property/lastModifiedDate" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData16lastModifiedDateGSqCSo6NSDate_">lastModifiedDate</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Extensions/NSDate.html">NSDate</a></code> object corresponding to the last modified time stamp.</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">lastModifiedDate</span><span class="p">:</span> <span class="kt">NSDate</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:FC11UsergridSDK20UsergridFileMetaDatacFT16fileMetaDataJSONGVs10DictionarySSPs9AnyObject___S0_"></a>
- <a name="//apple_ref/swift/Method/init(fileMetaDataJSON:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridFileMetaDatacFT16fileMetaDataJSONGVs10DictionarySSPs9AnyObject___S0_">init(fileMetaDataJSON:)</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/UsergridFileMetaData.html">UsergridFileMetaData</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">fileMetaDataJSON</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">])</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>fileMetaDataJSON</em>
- </code>
- </td>
- <td>
- <div>
- <p>The file meta data JSON dictionary.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</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:FC11UsergridSDK20UsergridFileMetaDatacFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridFileMetaDatacFT5coderCSo7NSCoder_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:FC11UsergridSDK20UsergridFileMetaData15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridFileMetaData15encodeWithCoderFCSo7NSCoderT_">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>
[06/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/js/jquery.min.js
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/js/jquery.min.js b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/js/jquery.min.js
deleted file mode 100755
index ab28a24..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/js/jquery.min.js
+++ /dev/null
@@ -1,4 +0,0 @@
-/*! jQuery v1.11.1 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */
-!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.1",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,argumen
ts))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a=
=a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(o,"ms-").replace(p,q)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=r(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d
===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(n,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(r(Object(a))?m.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=r(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),m.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(ar
guments)))},e.guid=a.guid=a.guid||m.guid++,e):void 0},now:function(){return+new Date},support:k}),m.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function r(a){var b=a.length,c=m.type(a);return"function"===c||m.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var s=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+-new Date,v=a.document,w=0,x=0,y=gb(),z=gb(),A=gb(),B=function(a,b){return a===b&&(l=!0),0},C="undefined",D=1<<31,E={}.hasOwnProperty,F=[],G=F.pop,H=F.push,I=F.push,J=F.slice,K=F.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},L="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",N="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",O=N.replace("w","w#"),P="\\["+M+"*("+N+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[
^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+O+"))|)"+M+"*\\]",Q=":("+N+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+P+")*)|.*)\\)|)",R=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),S=new RegExp("^"+M+"*,"+M+"*"),T=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp("="+M+"*([^\\]'\"]*?)"+M+"*\\]","g"),V=new RegExp(Q),W=new RegExp("^"+O+"$"),X={ID:new RegExp("^#("+N+")"),CLASS:new RegExp("^\\.("+N+")"),TAG:new RegExp("^("+N.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+Q),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+L+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/^(?:input|select|textarea|button)$/i,Z=/^h\d$/i,$=/^[^{]+\{\s*\[native \w/,_=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ab=/[+~]/,
bb=/'|\\/g,cb=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),db=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{I.apply(F=J.call(v.childNodes),v.childNodes),F[v.childNodes.length].nodeType}catch(eb){I={apply:F.length?function(a,b){H.apply(a,J.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fb(a,b,d,e){var f,h,j,k,l,o,r,s,w,x;if((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,d=d||[],!a||"string"!=typeof a)return d;if(1!==(k=b.nodeType)&&9!==k)return[];if(p&&!e){if(f=_.exec(a))if(j=f[1]){if(9===k){if(h=b.getElementById(j),!h||!h.parentNode)return d;if(h.id===j)return d.push(h),d}else if(b.ownerDocument&&(h=b.ownerDocument.getElementById(j))&&t(b,h)&&h.id===j)return d.push(h),d}else{if(f[2])return I.apply(d,b.getElementsByTagName(a)),d;if((j=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return I.apply(d,b.getElementsByClassName(j)),d}if(c.qsa&&
(!q||!q.test(a))){if(s=r=u,w=b,x=9===k&&a,1===k&&"object"!==b.nodeName.toLowerCase()){o=g(a),(r=b.getAttribute("id"))?s=r.replace(bb,"\\$&"):b.setAttribute("id",s),s="[id='"+s+"'] ",l=o.length;while(l--)o[l]=s+qb(o[l]);w=ab.test(a)&&ob(b.parentNode)||b,x=o.join(",")}if(x)try{return I.apply(d,w.querySelectorAll(x)),d}catch(y){}finally{r||b.removeAttribute("id")}}}return i(a.replace(R,"$1"),b,d,e)}function gb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function hb(a){return a[u]=!0,a}function ib(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function jb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function kb(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||D)-(~a.sourceIndex||D);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function lb(a){return function(b){var c=b.nodeName.toLower
Case();return"input"===c&&b.type===a}}function mb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function nb(a){return hb(function(b){return b=+b,hb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function ob(a){return a&&typeof a.getElementsByTagName!==C&&a}c=fb.support={},f=fb.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fb.setDocument=function(a){var b,e=a?a.ownerDocument||a:v,g=e.defaultView;return e!==n&&9===e.nodeType&&e.documentElement?(n=e,o=e.documentElement,p=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){m()},!1):g.attachEvent&&g.attachEvent("onunload",function(){m()})),c.attributes=ib(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ib(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassNam
e=$.test(e.getElementsByClassName)&&ib(function(a){return a.innerHTML="<div class='a'></div><div class='a i'></div>",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=ib(function(a){return o.appendChild(a).id=u,!e.getElementsByName||!e.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==C&&p){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){var c=typeof a.getAttributeNode!==C&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==C?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a
,b){return typeof b.getElementsByClassName!==C&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=$.test(e.querySelectorAll))&&(ib(function(a){a.innerHTML="<select msallowclip=''><option selected=''></option></select>",a.querySelectorAll("[msallowclip^='']").length&&q.push("[*^$]="+M+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+M+"*(?:value|"+L+")"),a.querySelectorAll(":checked").length||q.push(":checked")}),ib(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+M+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=$.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ib(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",Q)}),q=q.length&&new RegExp(q.join("
|")),r=r.length&&new RegExp(r.join("|")),b=$.test(o.compareDocumentPosition),t=b||$.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===v&&t(v,a)?-1:b===e||b.ownerDocument===v&&t(v,b)?1:k?K.call(k,a)-K.call(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],i=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:k?K.call(k,a)-K.call(k,b):0;if(f===g)return kb(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)i.unshift(c);while(h[d]=
==i[d])d++;return d?kb(h[d],i[d]):h[d]===v?-1:i[d]===v?1:0},e):n},fb.matches=function(a,b){return fb(a,null,null,b)},fb.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(U,"='$1']"),!(!c.matchesSelector||!p||r&&r.test(b)||q&&q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fb(b,n,null,[a]).length>0},fb.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fb.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&E.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fb.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fb.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=
null,a},e=fb.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fb.selectors={cacheLength:50,createPseudo:hb,match:X,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(cb,db),a[3]=(a[3]||a[4]||a[5]||"").replace(cb,db),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fb.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fb.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return X.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&V.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.len
gth)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(cb,db).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+M+")"+a+"("+M+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==C&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fb.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowe
rCase(),s=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){k=q[u]||(q[u]={}),j=k[a]||[],n=j[0]===w&&j[1],m=j[0]===w&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[w,n,m];break}}else if(s&&(j=(b[u]||(b[u]={}))[a])&&j[0]===w)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(s&&((l[u]||(l[u]={}))[a]=[w,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fb.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?hb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=K.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:hb(function(a){var b=[],c=[],d=h(a.replace(R,"$1"));retu
rn d[u]?hb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:hb(function(a){return function(b){return fb(a,b).length>0}}),contains:hb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:hb(function(a){return W.test(a||"")||fb.error("unsupported lang: "+a),a=a.replace(cb,db).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"
===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Z.test(a.nodeName)},input:function(a){return Y.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:nb(function(){return[0]}),last:nb(function(a,b){return[b-1]}),eq:nb(function(a,b,c){return[0>c?c+b:c]}),even:nb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:nb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:nb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:nb(function(a,b,c){for(var d=0>c?c+b:c;++d<b;)a.push(d);return a})}},d.pseudos.n
th=d.pseudos.eq;for(b in{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})d.pseudos[b]=lb(b);for(b in{submit:!0,reset:!0})d.pseudos[b]=mb(b);function pb(){}pb.prototype=d.filters=d.pseudos,d.setFilters=new pb,g=fb.tokenize=function(a,b){var c,e,f,g,h,i,j,k=z[a+" "];if(k)return b?0:k.slice(0);h=a,i=[],j=d.preFilter;while(h){(!c||(e=S.exec(h)))&&(e&&(h=h.slice(e[0].length)||h),i.push(f=[])),c=!1,(e=T.exec(h))&&(c=e.shift(),f.push({value:c,type:e[0].replace(R," ")}),h=h.slice(c.length));for(g in d.filter)!(e=X[g].exec(h))||j[g]&&!(e=j[g](e))||(c=e.shift(),f.push({value:c,type:g,matches:e}),h=h.slice(c.length));if(!c)break}return b?h.length:h?fb.error(a):z(a,i).slice(0)};function qb(a){for(var b=0,c=a.length,d="";c>b;b++)d+=a[b].value;return d}function rb(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(
b=b[d])if(1===b.nodeType||e){if(i=b[u]||(b[u]={}),(h=i[d])&&h[0]===w&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function sb(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function tb(a,b,c){for(var d=0,e=b.length;e>d;d++)fb(a,b[d],c);return c}function ub(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function vb(a,b,c,d,e,f){return d&&!d[u]&&(d=vb(d)),e&&!e[u]&&(e=vb(e,f)),hb(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||tb(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ub(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ub(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?K.call(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ub(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):I.apply(g,r)})}fu
nction wb(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=rb(function(a){return a===b},h,!0),l=rb(function(a){return K.call(b,a)>-1},h,!0),m=[function(a,c,d){return!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d))}];f>i;i++)if(c=d.relative[a[i].type])m=[rb(sb(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return vb(i>1&&sb(m),i>1&&qb(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(R,"$1"),c,e>i&&wb(a.slice(i,e)),f>e&&wb(a=a.slice(e)),f>e&&qb(a))}m.push(c)}return sb(m)}function xb(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,m,o,p=0,q="0",r=f&&[],s=[],t=j,u=f||e&&d.find.TAG("*",k),v=w+=null==t?1:Math.random()||.1,x=u.length;for(k&&(j=g!==n&&g);q!==x&&null!=(l=u[q]);q++){if(e&&l){m=0;while(o=a[m++])if(o(l,g,h)){i.push(l);break}k&&(w=v)}c&&((l=!o&&l)&&p--,f&&r.push(l))}if(p+=q,c&&q!==p){m=0;while(o=b[m++])o(r,s,g,h);if(f){if(p>0)while(q--)r[q]||s[
q]||(s[q]=G.call(i));s=ub(s)}I.apply(i,s),k&&!f&&s.length>0&&p+b.length>1&&fb.uniqueSort(i)}return k&&(w=v,j=t),r};return c?hb(f):f}return h=fb.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wb(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xb(e,d)),f.selector=a}return f},i=fb.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(cb,db),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=X.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(cb,db),ab.test(j[0].type)&&ob(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qb(j),!a)return I.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,ab.test(a)&&ob(b.parentNode)||b),e},c.sortStable=u.split("").sort
(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ib(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ib(function(a){return a.innerHTML="<a href='#'></a>","#"===a.firstChild.getAttribute("href")})||jb("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ib(function(a){return a.innerHTML="<input/>",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||jb("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ib(function(a){return null==a.getAttribute("disabled")})||jb(L,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fb}(a);m.find=s,m.expr=s.selectors,m.expr[":"]=m.expr.pseudos,m.unique=s.uniqueSort,m.text=s.getText,m.isXMLDoc=s.isXML,m.contains=s.contains;var t=m.expr.match.needsContext,u=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,v=/^.[^:#\[\.,]*$/;function w(a,b,c
){if(m.isFunction(b))return m.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return m.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(v.test(b))return m.filter(b,a,c);b=m.filter(b,a)}return m.grep(a,function(a){return m.inArray(a,b)>=0!==c})}m.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?m.find.matchesSelector(d,a)?[d]:[]:m.find.matches(a,m.grep(b,function(a){return 1===a.nodeType}))},m.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(m(a).filter(function(){for(b=0;e>b;b++)if(m.contains(d[b],this))return!0}));for(b=0;e>b;b++)m.find(a,d[b],c);return c=this.pushStack(e>1?m.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(w(this,a||[],!1))},not:function(a){return this.pushStack(w(this,a||[],!0))},is:function(a){return!!w(this,"string"==typeof a&&t.test(a)?m(a):a||[],!1).length}});var x,y=a.document,z=/^(
?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,A=m.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:z.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||x).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof m?b[0]:b,m.merge(this,m.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:y,!0)),u.test(c[1])&&m.isPlainObject(b))for(c in b)m.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}if(d=y.getElementById(c[2]),d&&d.parentNode){if(d.id!==c[2])return x.find(a);this.length=1,this[0]=d}return this.context=y,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):m.isFunction(a)?"undefined"!=typeof x.ready?x.ready(a):a(m):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),m.makeArray(a,this))};A.prototype=m.fn,x=m(y);var B=/^(?:parents|prev(?:Until|All))/,C={children:!0,contents:!0,next:!0,prev:!0};m.extend({dir:function(a,b,c){var d=[],e=
a[b];while(e&&9!==e.nodeType&&(void 0===c||1!==e.nodeType||!m(e).is(c)))1===e.nodeType&&d.push(e),e=e[b];return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),m.fn.extend({has:function(a){var b,c=m(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(m.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=t.test(a)||"string"!=typeof a?m(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&m.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?m.unique(f):f)},index:function(a){return a?"string"==typeof a?m.inArray(this[0],m(a)):m.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(m.unique(m.merge(this.get(),m(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function
D(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}m.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return m.dir(a,"parentNode")},parentsUntil:function(a,b,c){return m.dir(a,"parentNode",c)},next:function(a){return D(a,"nextSibling")},prev:function(a){return D(a,"previousSibling")},nextAll:function(a){return m.dir(a,"nextSibling")},prevAll:function(a){return m.dir(a,"previousSibling")},nextUntil:function(a,b,c){return m.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return m.dir(a,"previousSibling",c)},siblings:function(a){return m.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return m.sibling(a.firstChild)},contents:function(a){return m.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:m.merge([],a.childNodes)}},function(a,b){m.fn[a]=function(c,d){var e=m.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=m.filter(d,e)),this.length>1&&(C[a]||(e=m.unique(e)),B.test(a)&&(e=e
.reverse())),this.pushStack(e)}});var E=/\S+/g,F={};function G(a){var b=F[a]={};return m.each(a.match(E)||[],function(a,c){b[c]=!0}),b}m.Callbacks=function(a){a="string"==typeof a?F[a]||G(a):m.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(c=a.memory&&l,d=!0,f=g||0,g=0,e=h.length,b=!0;h&&e>f;f++)if(h[f].apply(l[0],l[1])===!1&&a.stopOnFalse){c=!1;break}b=!1,h&&(i?i.length&&j(i.shift()):c?h=[]:k.disable())},k={add:function(){if(h){var d=h.length;!function f(b){m.each(b,function(b,c){var d=m.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&f(c)})}(arguments),b?e=h.length:c&&(g=d,j(c))}return this},remove:function(){return h&&m.each(arguments,function(a,c){var d;while((d=m.inArray(c,h,d))>-1)h.splice(d,1),b&&(e>=d&&e--,f>=d&&f--)}),this},has:function(a){return a?m.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],e=0,this},disable:function(){return h=i=c=void 0,this},disabled:function(){return!h},lock:function(){return i=voi
d 0,c||k.disable(),this},locked:function(){return!i},fireWith:function(a,c){return!h||d&&!i||(c=c||[],c=[a,c.slice?c.slice():c],b?i.push(c):j(c)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!d}};return k},m.extend({Deferred:function(a){var b=[["resolve","done",m.Callbacks("once memory"),"resolved"],["reject","fail",m.Callbacks("once memory"),"rejected"],["notify","progress",m.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return m.Deferred(function(c){m.each(b,function(b,f){var g=m.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&m.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?m.extend(a,d):d}},e={};return d.pipe=d.then,m.each(b,function(a,f){var g=
f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&m.isFunction(a.promise)?e:0,g=1===f?a:m.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&m.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var H;m.fn.ready=function(a){return m.ready.promise().done(a),this},m.extend({isReady:!1,readyWait:1,holdReady:function(a){a?m.readyWait++:m.ready(!0)},ready:function(a){if(a===!0?!--m.readyWait:!m.isReady){if(!y.body)return setTimeout(m.ready);m.isReady=!0,a!==!0&&--m.readyWait>0||(H.resolveWith(y,[m]),m
.fn.triggerHandler&&(m(y).triggerHandler("ready"),m(y).off("ready")))}}});function I(){y.addEventListener?(y.removeEventListener("DOMContentLoaded",J,!1),a.removeEventListener("load",J,!1)):(y.detachEvent("onreadystatechange",J),a.detachEvent("onload",J))}function J(){(y.addEventListener||"load"===event.type||"complete"===y.readyState)&&(I(),m.ready())}m.ready.promise=function(b){if(!H)if(H=m.Deferred(),"complete"===y.readyState)setTimeout(m.ready);else if(y.addEventListener)y.addEventListener("DOMContentLoaded",J,!1),a.addEventListener("load",J,!1);else{y.attachEvent("onreadystatechange",J),a.attachEvent("onload",J);var c=!1;try{c=null==a.frameElement&&y.documentElement}catch(d){}c&&c.doScroll&&!function e(){if(!m.isReady){try{c.doScroll("left")}catch(a){return setTimeout(e,50)}I(),m.ready()}}()}return H.promise(b)};var K="undefined",L;for(L in m(k))break;k.ownLast="0"!==L,k.inlineBlockNeedsLayout=!1,m(function(){var a,b,c,d;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.crea
teElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1",k.inlineBlockNeedsLayout=a=3===b.offsetWidth,a&&(c.style.zoom=1)),c.removeChild(d))}),function(){var a=y.createElement("div");if(null==k.deleteExpando){k.deleteExpando=!0;try{delete a.test}catch(b){k.deleteExpando=!1}}a=null}(),m.acceptData=function(a){var b=m.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b};var M=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,N=/([A-Z])/g;function O(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(N,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:M.test(c)?m.parseJSON(c):c}catch(e){}m.data(a,b,c)}else c=void 0}return c}function P(a){var b;for(b
in a)if(("data"!==b||!m.isEmptyObject(a[b]))&&"toJSON"!==b)return!1;return!0}function Q(a,b,d,e){if(m.acceptData(a)){var f,g,h=m.expando,i=a.nodeType,j=i?m.cache:a,k=i?a[h]:a[h]&&h;
-if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||m.guid++:h),j[k]||(j[k]=i?{}:{toJSON:m.noop}),("object"==typeof b||"function"==typeof b)&&(e?j[k]=m.extend(j[k],b):j[k].data=m.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[m.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[m.camelCase(b)])):f=g,f}}function R(a,b,c){if(m.acceptData(a)){var d,e,f=a.nodeType,g=f?m.cache:a,h=f?a[m.expando]:m.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){m.isArray(b)?b=b.concat(m.map(b,m.camelCase)):b in d?b=[b]:(b=m.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!P(d):!m.isEmptyObject(d))return}(c||(delete g[h].data,P(g[h])))&&(f?m.cleanData([a],!0):k.deleteExpando||g!=g.window?delete g[h]:g[h]=null)}}}m.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?m.cache[a[m.expando]]:a[m.expando],!!a&&!P(a)},
data:function(a,b,c){return Q(a,b,c)},removeData:function(a,b){return R(a,b)},_data:function(a,b,c){return Q(a,b,c,!0)},_removeData:function(a,b){return R(a,b,!0)}}),m.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=m.data(f),1===f.nodeType&&!m._data(f,"parsedAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=m.camelCase(d.slice(5)),O(f,d,e[d])));m._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){m.data(this,a)}):arguments.length>1?this.each(function(){m.data(this,a,b)}):f?O(f,a,m.data(f,a)):void 0},removeData:function(a){return this.each(function(){m.removeData(this,a)})}}),m.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=m._data(a,b),c&&(!d||m.isArray(c)?d=m._data(a,b,m.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=m.queue(a,b),d=c.length,e=c.shift(),f=m._queueHooks(a,b),g=function(){m.dequeue(a,b)};"inprogress"===e&&(
e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return m._data(a,c)||m._data(a,c,{empty:m.Callbacks("once memory").add(function(){m._removeData(a,b+"queue"),m._removeData(a,c)})})}}),m.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.length<c?m.queue(this[0],a):void 0===b?this:this.each(function(){var c=m.queue(this,a,b);m._queueHooks(this,a),"fx"===a&&"inprogress"!==c[0]&&m.dequeue(this,a)})},dequeue:function(a){return this.each(function(){m.dequeue(this,a)})},clearQueue:function(a){return this.queue(a||"fx",[])},promise:function(a,b){var c,d=1,e=m.Deferred(),f=this,g=this.length,h=function(){--d||e.resolveWith(f,[f])};"string"!=typeof a&&(b=a,a=void 0),a=a||"fx";while(g--)c=m._data(f[g],a+"queueHooks"),c&&c.empty&&(d++,c.empty.add(h));return h(),e.promise(b)}});var S=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,T=["Top","Right","Botto
m","Left"],U=function(a,b){return a=b||a,"none"===m.css(a,"display")||!m.contains(a.ownerDocument,a)},V=m.access=function(a,b,c,d,e,f,g){var h=0,i=a.length,j=null==c;if("object"===m.type(c)){e=!0;for(h in c)m.access(a,b,h,c[h],!0,f,g)}else if(void 0!==d&&(e=!0,m.isFunction(d)||(g=!0),j&&(g?(b.call(a,d),b=null):(j=b,b=function(a,b,c){return j.call(m(a),c)})),b))for(;i>h;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},W=/^(?:checkbox|radio)$/i;!function(){var a=y.createElement("input"),b=y.createElement("div"),c=y.createDocumentFragment();if(b.innerHTML=" <link/><table></table><a href='/a'>a</a><input type='checkbox'/>",k.leadingWhitespace=3===b.firstChild.nodeType,k.tbody=!b.getElementsByTagName("tbody").length,k.htmlSerialize=!!b.getElementsByTagName("link").length,k.html5Clone="<:nav></:nav>"!==y.createElement("nav").cloneNode(!0).outerHTML,a.type="checkbox",a.checked=!0,c.appendChild(a),k.appendChecked=a.checked,b.innerHTML="<textarea>x</textarea>
",k.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue,c.appendChild(b),b.innerHTML="<input type='radio' checked='checked' name='t'/>",k.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,k.noCloneEvent=!0,b.attachEvent&&(b.attachEvent("onclick",function(){k.noCloneEvent=!1}),b.cloneNode(!0).click()),null==k.deleteExpando){k.deleteExpando=!0;try{delete b.test}catch(d){k.deleteExpando=!1}}}(),function(){var b,c,d=y.createElement("div");for(b in{submit:!0,change:!0,focusin:!0})c="on"+b,(k[b+"Bubbles"]=c in a)||(d.setAttribute(c,"t"),k[b+"Bubbles"]=d.attributes[c].expando===!1);d=null}();var X=/^(?:input|select|textarea)$/i,Y=/^key/,Z=/^(?:mouse|pointer|contextmenu)|click/,$=/^(?:focusinfocus|focusoutblur)$/,_=/^([^.]*)(?:\.(.+)|)$/;function ab(){return!0}function bb(){return!1}function cb(){try{return y.activeElement}catch(a){}}m.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m._data(a);if(r){c.handler&&(i=c,c=i.handler,e=i.selector),c.guid||(c.guid=
m.guid++),(g=r.events)||(g=r.events={}),(k=r.handle)||(k=r.handle=function(a){return typeof m===K||a&&m.event.triggered===a.type?void 0:m.event.dispatch.apply(k.elem,arguments)},k.elem=a),b=(b||"").match(E)||[""],h=b.length;while(h--)f=_.exec(b[h])||[],o=q=f[1],p=(f[2]||"").split(".").sort(),o&&(j=m.event.special[o]||{},o=(e?j.delegateType:j.bindType)||o,j=m.event.special[o]||{},l=m.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&m.expr.match.needsContext.test(e),namespace:p.join(".")},i),(n=g[o])||(n=g[o]=[],n.delegateCount=0,j.setup&&j.setup.call(a,d,p,k)!==!1||(a.addEventListener?a.addEventListener(o,k,!1):a.attachEvent&&a.attachEvent("on"+o,k))),j.add&&(j.add.call(a,l),l.handler.guid||(l.handler.guid=c.guid)),e?n.splice(n.delegateCount++,0,l):n.push(l),m.event.global[o]=!0);a=null}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m.hasData(a)&&m._data(a);if(r&&(k=r.events)){b=(b||"").match(E)||[""],j=b.length;while(j--)if(h=_.exec(b[j])||
[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=m.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,n=k[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),i=f=n.length;while(f--)g=n[f],!e&&q!==g.origType||c&&c.guid!==g.guid||h&&!h.test(g.namespace)||d&&d!==g.selector&&("**"!==d||!g.selector)||(n.splice(f,1),g.selector&&n.delegateCount--,l.remove&&l.remove.call(a,g));i&&!n.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||m.removeEvent(a,o,r.handle),delete k[o])}else for(o in k)m.event.remove(a,o+b[j],c,d,!0);m.isEmptyObject(k)&&(delete r.handle,m._removeData(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,l,n,o=[d||y],p=j.call(b,"type")?b.type:b,q=j.call(b,"namespace")?b.namespace.split("."):[];if(h=l=d=d||y,3!==d.nodeType&&8!==d.nodeType&&!$.test(p+m.event.triggered)&&(p.indexOf(".")>=0&&(q=p.split("."),p=q.shift(),q.sort()),g=p.indexOf(":")<0&&"on"+p,b=b[m.expando]?b:new m.Event(p,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=q.join("
."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:m.makeArray(c,[b]),k=m.event.special[p]||{},e||!k.trigger||k.trigger.apply(d,c)!==!1)){if(!e&&!k.noBubble&&!m.isWindow(d)){for(i=k.delegateType||p,$.test(i+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),l=h;l===(d.ownerDocument||y)&&o.push(l.defaultView||l.parentWindow||a)}n=0;while((h=o[n++])&&!b.isPropagationStopped())b.type=n>1?i:k.bindType||p,f=(m._data(h,"events")||{})[b.type]&&m._data(h,"handle"),f&&f.apply(h,c),f=g&&h[g],f&&f.apply&&m.acceptData(h)&&(b.result=f.apply(h,c),b.result===!1&&b.preventDefault());if(b.type=p,!e&&!b.isDefaultPrevented()&&(!k._default||k._default.apply(o.pop(),c)===!1)&&m.acceptData(d)&&g&&d[p]&&!m.isWindow(d)){l=d[g],l&&(d[g]=null),m.event.triggered=p;try{d[p]()}catch(r){}m.event.triggered=void 0,l&&(d[g]=l)}return b.result}},dispatch:function(a){a=m.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(m.
_data(this,"events")||{})[a.type]||[],k=m.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=m.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,g=0;while((e=f.handlers[g++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(e.namespace))&&(a.handleObj=e,a.data=e.data,c=((m.event.special[e.origType]||{}).handle||e.handler).apply(f.elem,i),void 0!==c&&(a.result=c)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!=this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(e=[],f=0;h>f;f++)d=b[f],c=d.selector+" ",void 0===e[c]&&(e[c]=d.needsContext?m(c,this).index(i)>=0:m.find(c,this,null,[i]).length),e[c]&&e.push(d);e.length&&g.push({elem:i,hand
lers:e})}return h<b.length&&g.push({elem:this,handlers:b.slice(h)}),g},fix:function(a){if(a[m.expando])return a;var b,c,d,e=a.type,f=a,g=this.fixHooks[e];g||(this.fixHooks[e]=g=Z.test(e)?this.mouseHooks:Y.test(e)?this.keyHooks:{}),d=g.props?this.props.concat(g.props):this.props,a=new m.Event(f),b=d.length;while(b--)c=d[b],a[c]=f[c];return a.target||(a.target=f.srcElement||y),3===a.target.nodeType&&(a.target=a.target.parentNode),a.metaKey=!!a.metaKey,g.filter?g.filter(a,f):a},props:"altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "),fixHooks:{},keyHooks:{props:"char charCode key keyCode".split(" "),filter:function(a,b){return null==a.which&&(a.which=null!=b.charCode?b.charCode:b.keyCode),a}},mouseHooks:{props:"button buttons clientX clientY fromElement offsetX offsetY pageX pageY screenX screenY toElement".split(" "),filter:function(a,b){var c,d,e,f=b.button,g=b.fromElement;return null==a.pageX&&null!=b.cl
ientX&&(d=a.target.ownerDocument||y,e=d.documentElement,c=d.body,a.pageX=b.clientX+(e&&e.scrollLeft||c&&c.scrollLeft||0)-(e&&e.clientLeft||c&&c.clientLeft||0),a.pageY=b.clientY+(e&&e.scrollTop||c&&c.scrollTop||0)-(e&&e.clientTop||c&&c.clientTop||0)),!a.relatedTarget&&g&&(a.relatedTarget=g===a.target?b.toElement:g),a.which||void 0===f||(a.which=1&f?1:2&f?3:4&f?2:0),a}},special:{load:{noBubble:!0},focus:{trigger:function(){if(this!==cb()&&this.focus)try{return this.focus(),!1}catch(a){}},delegateType:"focusin"},blur:{trigger:function(){return this===cb()&&this.blur?(this.blur(),!1):void 0},delegateType:"focusout"},click:{trigger:function(){return m.nodeName(this,"input")&&"checkbox"===this.type&&this.click?(this.click(),!1):void 0},_default:function(a){return m.nodeName(a.target,"a")}},beforeunload:{postDispatch:function(a){void 0!==a.result&&a.originalEvent&&(a.originalEvent.returnValue=a.result)}}},simulate:function(a,b,c,d){var e=m.extend(new m.Event,c,{type:a,isSimulated:!0,origin
alEvent:{}});d?m.event.trigger(e,null,b):m.event.dispatch.call(b,e),e.isDefaultPrevented()&&c.preventDefault()}},m.removeEvent=y.removeEventListener?function(a,b,c){a.removeEventListener&&a.removeEventListener(b,c,!1)}:function(a,b,c){var d="on"+b;a.detachEvent&&(typeof a[d]===K&&(a[d]=null),a.detachEvent(d,c))},m.Event=function(a,b){return this instanceof m.Event?(a&&a.type?(this.originalEvent=a,this.type=a.type,this.isDefaultPrevented=a.defaultPrevented||void 0===a.defaultPrevented&&a.returnValue===!1?ab:bb):this.type=a,b&&m.extend(this,b),this.timeStamp=a&&a.timeStamp||m.now(),void(this[m.expando]=!0)):new m.Event(a,b)},m.Event.prototype={isDefaultPrevented:bb,isPropagationStopped:bb,isImmediatePropagationStopped:bb,preventDefault:function(){var a=this.originalEvent;this.isDefaultPrevented=ab,a&&(a.preventDefault?a.preventDefault():a.returnValue=!1)},stopPropagation:function(){var a=this.originalEvent;this.isPropagationStopped=ab,a&&(a.stopPropagation&&a.stopPropagation(),a.cance
lBubble=!0)},stopImmediatePropagation:function(){var a=this.originalEvent;this.isImmediatePropagationStopped=ab,a&&a.stopImmediatePropagation&&a.stopImmediatePropagation(),this.stopPropagation()}},m.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(a,b){m.event.special[a]={delegateType:b,bindType:b,handle:function(a){var c,d=this,e=a.relatedTarget,f=a.handleObj;return(!e||e!==d&&!m.contains(d,e))&&(a.type=f.origType,c=f.handler.apply(this,arguments),a.type=b),c}}}),k.submitBubbles||(m.event.special.submit={setup:function(){return m.nodeName(this,"form")?!1:void m.event.add(this,"click._submit keypress._submit",function(a){var b=a.target,c=m.nodeName(b,"input")||m.nodeName(b,"button")?b.form:void 0;c&&!m._data(c,"submitBubbles")&&(m.event.add(c,"submit._submit",function(a){a._submit_bubble=!0}),m._data(c,"submitBubbles",!0))})},postDispatch:function(a){a._submit_bubble&&(delete a._submit_bubble,this.parentNode&&!a.isTrig
ger&&m.event.simulate("submit",this.parentNode,a,!0))},teardown:function(){return m.nodeName(this,"form")?!1:void m.event.remove(this,"._submit")}}),k.changeBubbles||(m.event.special.change={setup:function(){return X.test(this.nodeName)?(("checkbox"===this.type||"radio"===this.type)&&(m.event.add(this,"propertychange._change",function(a){"checked"===a.originalEvent.propertyName&&(this._just_changed=!0)}),m.event.add(this,"click._change",function(a){this._just_changed&&!a.isTrigger&&(this._just_changed=!1),m.event.simulate("change",this,a,!0)})),!1):void m.event.add(this,"beforeactivate._change",function(a){var b=a.target;X.test(b.nodeName)&&!m._data(b,"changeBubbles")&&(m.event.add(b,"change._change",function(a){!this.parentNode||a.isSimulated||a.isTrigger||m.event.simulate("change",this.parentNode,a,!0)}),m._data(b,"changeBubbles",!0))})},handle:function(a){var b=a.target;return this!==b||a.isSimulated||a.isTrigger||"radio"!==b.type&&"checkbox"!==b.type?a.handleObj.handler.apply(th
is,arguments):void 0},teardown:function(){return m.event.remove(this,"._change"),!X.test(this.nodeName)}}),k.focusinBubbles||m.each({focus:"focusin",blur:"focusout"},function(a,b){var c=function(a){m.event.simulate(b,a.target,m.event.fix(a),!0)};m.event.special[b]={setup:function(){var d=this.ownerDocument||this,e=m._data(d,b);e||d.addEventListener(a,c,!0),m._data(d,b,(e||0)+1)},teardown:function(){var d=this.ownerDocument||this,e=m._data(d,b)-1;e?m._data(d,b,e):(d.removeEventListener(a,c,!0),m._removeData(d,b))}}}),m.fn.extend({on:function(a,b,c,d,e){var f,g;if("object"==typeof a){"string"!=typeof b&&(c=c||b,b=void 0);for(f in a)this.on(f,b,c,a[f],e);return this}if(null==c&&null==d?(d=b,c=b=void 0):null==d&&("string"==typeof b?(d=c,c=void 0):(d=c,c=b,b=void 0)),d===!1)d=bb;else if(!d)return this;return 1===e&&(g=d,d=function(a){return m().off(a),g.apply(this,arguments)},d.guid=g.guid||(g.guid=m.guid++)),this.each(function(){m.event.add(this,a,d,c,b)})},one:function(a,b,c,d){return
this.on(a,b,c,d,1)},off:function(a,b,c){var d,e;if(a&&a.preventDefault&&a.handleObj)return d=a.handleObj,m(a.delegateTarget).off(d.namespace?d.origType+"."+d.namespace:d.origType,d.selector,d.handler),this;if("object"==typeof a){for(e in a)this.off(e,b,a[e]);return this}return(b===!1||"function"==typeof b)&&(c=b,b=void 0),c===!1&&(c=bb),this.each(function(){m.event.remove(this,a,c,b)})},trigger:function(a,b){return this.each(function(){m.event.trigger(a,b,this)})},triggerHandler:function(a,b){var c=this[0];return c?m.event.trigger(a,b,c,!0):void 0}});function db(a){var b=eb.split("|"),c=a.createDocumentFragment();if(c.createElement)while(b.length)c.createElement(b.pop());return c}var eb="abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",fb=/ jQuery\d+="(?:null|\d+)"/g,gb=new RegExp("<(?:"+eb+")[\\s/>]","i"),hb=/^\s+/,ib=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]
+)[^>]*)\/>/gi,jb=/<([\w:]+)/,kb=/<tbody/i,lb=/<|&#?\w+;/,mb=/<(?:script|style|link)/i,nb=/checked\s*(?:[^=]|=\s*.checked.)/i,ob=/^$|\/(?:java|ecma)script/i,pb=/^true\/(.*)/,qb=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g,rb={option:[1,"<select multiple='multiple'>","</select>"],legend:[1,"<fieldset>","</fieldset>"],area:[1,"<map>","</map>"],param:[1,"<object>","</object>"],thead:[1,"<table>","</table>"],tr:[2,"<table><tbody>","</tbody></table>"],col:[2,"<table><tbody></tbody><colgroup>","</colgroup></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:k.htmlSerialize?[0,"",""]:[1,"X<div>","</div>"]},sb=db(y),tb=sb.appendChild(y.createElement("div"));rb.optgroup=rb.option,rb.tbody=rb.tfoot=rb.colgroup=rb.caption=rb.thead,rb.th=rb.td;function ub(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==K?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==K?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||m.nodeName(d,b)?f.push
(d):m.merge(f,ub(d,b));return void 0===b||b&&m.nodeName(a,b)?m.merge([a],f):f}function vb(a){W.test(a.type)&&(a.defaultChecked=a.checked)}function wb(a,b){return m.nodeName(a,"table")&&m.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function xb(a){return a.type=(null!==m.find.attr(a,"type"))+"/"+a.type,a}function yb(a){var b=pb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function zb(a,b){for(var c,d=0;null!=(c=a[d]);d++)m._data(c,"globalEval",!b||m._data(b[d],"globalEval"))}function Ab(a,b){if(1===b.nodeType&&m.hasData(a)){var c,d,e,f=m._data(a),g=m._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)m.event.add(b,c,h[c][d])}g.data&&(g.data=m.extend({},g.data))}}function Bb(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!k.noCloneEvent&&b[m.expando]){e=m._data(b);for(d in e.events)m.removeEvent(b,d,e.handle);b.rem
oveAttribute(m.expando)}"script"===c&&b.text!==a.text?(xb(b).text=a.text,yb(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),k.html5Clone&&a.innerHTML&&!m.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&W.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}m.extend({clone:function(a,b,c){var d,e,f,g,h,i=m.contains(a.ownerDocument,a);if(k.html5Clone||m.isXMLDoc(a)||!gb.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(tb.innerHTML=a.outerHTML,tb.removeChild(f=tb.firstChild)),!(k.noCloneEvent&&k.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||m.isXMLDoc(a)))for(d=ub(f),h=ub(a),g=0;null!=(e=h[g]);++g)d[g]&&Bb(e,d[g]);if(b)if(c)for(h=h||ub(a),d=d||ub(f),g=0;null!=(e=h[g]);g++)Ab(e,d[g]);else Ab(a,f);return d=ub(f,"script"),d.length>0&&zb(d,!i&&ub(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e
,f,g,h,i,j,l,n=a.length,o=db(b),p=[],q=0;n>q;q++)if(f=a[q],f||0===f)if("object"===m.type(f))m.merge(p,f.nodeType?[f]:f);else if(lb.test(f)){h=h||o.appendChild(b.createElement("div")),i=(jb.exec(f)||["",""])[1].toLowerCase(),l=rb[i]||rb._default,h.innerHTML=l[1]+f.replace(ib,"<$1></$2>")+l[2],e=l[0];while(e--)h=h.lastChild;if(!k.leadingWhitespace&&hb.test(f)&&p.push(b.createTextNode(hb.exec(f)[0])),!k.tbody){f="table"!==i||kb.test(f)?"<table>"!==l[1]||kb.test(f)?0:h:h.firstChild,e=f&&f.childNodes.length;while(e--)m.nodeName(j=f.childNodes[e],"tbody")&&!j.childNodes.length&&f.removeChild(j)}m.merge(p,h.childNodes),h.textContent="";while(h.firstChild)h.removeChild(h.firstChild);h=o.lastChild}else p.push(b.createTextNode(f));h&&o.removeChild(h),k.appendChecked||m.grep(ub(p,"input"),vb),q=0;while(f=p[q++])if((!d||-1===m.inArray(f,d))&&(g=m.contains(f.ownerDocument,f),h=ub(o.appendChild(f),"script"),g&&zb(h),c)){e=0;while(f=h[e++])ob.test(f.type||"")&&c.push(f)}return h=null,o},cleanData:
function(a,b){for(var d,e,f,g,h=0,i=m.expando,j=m.cache,l=k.deleteExpando,n=m.event.special;null!=(d=a[h]);h++)if((b||m.acceptData(d))&&(f=d[i],g=f&&j[f])){if(g.events)for(e in g.events)n[e]?m.event.remove(d,e):m.removeEvent(d,e,g.handle);j[f]&&(delete j[f],l?delete d[i]:typeof d.removeAttribute!==K?d.removeAttribute(i):d[i]=null,c.push(f))}}}),m.fn.extend({text:function(a){return V(this,function(a){return void 0===a?m.text(this):this.empty().append((this[0]&&this[0].ownerDocument||y).createTextNode(a))},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:fu
nction(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?m.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||m.cleanData(ub(c)),c.parentNode&&(b&&m.contains(c.ownerDocument,c)&&zb(ub(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++){1===a.nodeType&&m.cleanData(ub(a,!1));while(a.firstChild)a.removeChild(a.firstChild);a.options&&m.nodeName(a,"select")&&(a.options.length=0)}return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return m.clone(this,a,b)})},html:function(a){return V(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a)return 1===b.nodeType?b.innerHTML.replace(fb,""):void 0;if(!("string"!=typeof a||mb.test(a)||!k.htmlSerialize&&gb.test(a)||!k.leadingWhitespace&&hb.test(a)||rb[(jb.exec(a)||["",""])[1].toLowerCase()])){a=a.replace(ib,"<$1></$2>");try{for(;d>c;
c++)b=this[c]||{},1===b.nodeType&&(m.cleanData(ub(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,m.cleanData(ub(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,l=this.length,n=this,o=l-1,p=a[0],q=m.isFunction(p);if(q||l>1&&"string"==typeof p&&!k.checkClone&&nb.test(p))return this.each(function(c){var d=n.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(l&&(i=m.buildFragment(a,this[0].ownerDocument,!1,this),c=i.firstChild,1===i.childNodes.length&&(i=c),c)){for(g=m.map(ub(i,"script"),xb),f=g.length;l>j;j++)d=i,j!==o&&(d=m.clone(d,!0,!0),f&&m.merge(g,ub(d,"script"))),b.call(this[j],d,j);if(f)for(h=g[g.length-1].ownerDocument,m.map(g,yb),j=0;f>j;j++)d=g[j],ob.test(d.type||"")&&!m._data(d,"globalEv
al")&&m.contains(h,d)&&(d.src?m._evalUrl&&m._evalUrl(d.src):m.globalEval((d.text||d.textContent||d.innerHTML||"").replace(qb,"")));i=c=null}return this}}),m.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){m.fn[a]=function(a){for(var c,d=0,e=[],g=m(a),h=g.length-1;h>=d;d++)c=d===h?this:this.clone(!0),m(g[d])[b](c),f.apply(e,c.get());return this.pushStack(e)}});var Cb,Db={};function Eb(b,c){var d,e=m(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:m.css(e[0],"display");return e.detach(),f}function Fb(a){var b=y,c=Db[a];return c||(c=Eb(a,b),"none"!==c&&c||(Cb=(Cb||m("<iframe frameborder='0' width='0' height='0'/>")).appendTo(b.documentElement),b=(Cb[0].contentWindow||Cb[0].contentDocument).document,b.write(),b.close(),c=Eb(a,b),Cb.detach()),Db[a]=c),c}!function(){var a;k.shrinkWrapBlocks=function(){if(null!=a)return a;a=!1;var b,c,d;return c=y.ge
tElementsByTagName("body")[0],c&&c.style?(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;display:block;margin:0;border:0;padding:1px;width:1px;zoom:1",b.appendChild(y.createElement("div")).style.width="5px",a=3!==b.offsetWidth),c.removeChild(d),a):void 0}}();var Gb=/^margin/,Hb=new RegExp("^("+S+")(?!px)[a-z%]+$","i"),Ib,Jb,Kb=/^(top|right|bottom|left)$/;a.getComputedStyle?(Ib=function(a){return a.ownerDocument.defaultView.getComputedStyle(a,null)},Jb=function(a,b,c){var d,e,f,g,h=a.style;return c=c||Ib(a),g=c?c.getPropertyValue(b)||c[b]:void 0,c&&(""!==g||m.contains(a.ownerDocument,a)||(g=m.style(a,b)),Hb.test(g)&&Gb.test(b)&&(d=h.width,e=h.minWidth,f=h.maxWidth,h.minWidth=h.maxWidth=h.width=g,g=c.width,h.width=d,h.minWidth=e,h.maxWidth=f)),void
0===g?g:g+""}):y.documentElement.currentStyle&&(Ib=function(a){return a.currentStyle},Jb=function(a,b,c){var d,e,f,g,h=a.style;return c=c||Ib(a),g=c?c[b]:void 0,null==g&&h&&h[b]&&(g=h[b]),Hb.test(g)&&!Kb.test(b)&&(d=h.left,e=a.runtimeStyle,f=e&&e.left,f&&(e.left=a.currentStyle.left),h.left="fontSize"===b?"1em":g,g=h.pixelLeft+"px",h.left=d,f&&(e.left=f)),void 0===g?g:g+""||"auto"});function Lb(a,b){return{get:function(){var c=a();if(null!=c)return c?void delete this.get:(this.get=b).apply(this,arguments)}}}!function(){var b,c,d,e,f,g,h;if(b=y.createElement("div"),b.innerHTML=" <link/><table></table><a href='/a'>a</a><input type='checkbox'/>",d=b.getElementsByTagName("a")[0],c=d&&d.style){c.cssText="float:left;opacity:.5",k.opacity="0.5"===c.opacity,k.cssFloat=!!c.cssFloat,b.style.backgroundClip="content-box",b.cloneNode(!0).style.backgroundClip="",k.clearCloneStyle="content-box"===b.style.backgroundClip,k.boxSizing=""===c.boxSizing||""===c.MozBoxSizing||""===c.WebkitBoxSizing,m.ex
tend(k,{reliableHiddenOffsets:function(){return null==g&&i(),g},boxSizingReliable:function(){return null==f&&i(),f},pixelPosition:function(){return null==e&&i(),e},reliableMarginRight:function(){return null==h&&i(),h}});function i(){var b,c,d,i;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),b.style.cssText="-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;display:block;margin-top:1%;top:1%;border:1px;padding:1px;width:4px;position:absolute",e=f=!1,h=!0,a.getComputedStyle&&(e="1%"!==(a.getComputedStyle(b,null)||{}).top,f="4px"===(a.getComputedStyle(b,null)||{width:"4px"}).width,i=b.appendChild(y.createElement("div")),i.style.cssText=b.style.cssText="-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;display:block;margin:0;border:0;padding:0",i.style.marginRight=
i.style.width="0",b.style.width="1px",h=!parseFloat((a.getComputedStyle(i,null)||{}).marginRight)),b.innerHTML="<table><tr><td></td><td>t</td></tr></table>",i=b.getElementsByTagName("td"),i[0].style.cssText="margin:0;border:0;padding:0;display:none",g=0===i[0].offsetHeight,g&&(i[0].style.display="",i[1].style.display="none",g=0===i[0].offsetHeight),c.removeChild(d))}}}(),m.swap=function(a,b,c,d){var e,f,g={};for(f in b)g[f]=a.style[f],a.style[f]=b[f];e=c.apply(a,d||[]);for(f in b)a.style[f]=g[f];return e};var Mb=/alpha\([^)]*\)/i,Nb=/opacity\s*=\s*([^)]*)/,Ob=/^(none|table(?!-c[ea]).+)/,Pb=new RegExp("^("+S+")(.*)$","i"),Qb=new RegExp("^([+-])=("+S+")","i"),Rb={position:"absolute",visibility:"hidden",display:"block"},Sb={letterSpacing:"0",fontWeight:"400"},Tb=["Webkit","O","Moz","ms"];function Ub(a,b){if(b in a)return b;var c=b.charAt(0).toUpperCase()+b.slice(1),d=b,e=Tb.length;while(e--)if(b=Tb[e]+c,b in a)return b;return d}function Vb(a,b){for(var c,d,e,f=[],g=0,h=a.length;h>g;g++
)d=a[g],d.style&&(f[g]=m._data(d,"olddisplay"),c=d.style.display,b?(f[g]||"none"!==c||(d.style.display=""),""===d.style.display&&U(d)&&(f[g]=m._data(d,"olddisplay",Fb(d.nodeName)))):(e=U(d),(c&&"none"!==c||!e)&&m._data(d,"olddisplay",e?c:m.css(d,"display"))));for(g=0;h>g;g++)d=a[g],d.style&&(b&&"none"!==d.style.display&&""!==d.style.display||(d.style.display=b?f[g]||"":"none"));return a}function Wb(a,b,c){var d=Pb.exec(b);return d?Math.max(0,d[1]-(c||0))+(d[2]||"px"):b}function Xb(a,b,c,d,e){for(var f=c===(d?"border":"content")?4:"width"===b?1:0,g=0;4>f;f+=2)"margin"===c&&(g+=m.css(a,c+T[f],!0,e)),d?("content"===c&&(g-=m.css(a,"padding"+T[f],!0,e)),"margin"!==c&&(g-=m.css(a,"border"+T[f]+"Width",!0,e))):(g+=m.css(a,"padding"+T[f],!0,e),"padding"!==c&&(g+=m.css(a,"border"+T[f]+"Width",!0,e)));return g}function Yb(a,b,c){var d=!0,e="width"===b?a.offsetWidth:a.offsetHeight,f=Ib(a),g=k.boxSizing&&"border-box"===m.css(a,"boxSizing",!1,f);if(0>=e||null==e){if(e=Jb(a,b,f),(0>e||null==e)&&(
e=a.style[b]),Hb.test(e))return e;d=g&&(k.boxSizingReliable()||e===a.style[b]),e=parseFloat(e)||0}return e+Xb(a,b,c||(g?"border":"content"),d,f)+"px"}m.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=Jb(a,"opacity");return""===c?"1":c}}}},cssNumber:{columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":k.cssFloat?"cssFloat":"styleFloat"},style:function(a,b,c,d){if(a&&3!==a.nodeType&&8!==a.nodeType&&a.style){var e,f,g,h=m.camelCase(b),i=a.style;if(b=m.cssProps[h]||(m.cssProps[h]=Ub(i,h)),g=m.cssHooks[b]||m.cssHooks[h],void 0===c)return g&&"get"in g&&void 0!==(e=g.get(a,!1,d))?e:i[b];if(f=typeof c,"string"===f&&(e=Qb.exec(c))&&(c=(e[1]+1)*e[2]+parseFloat(m.css(a,b)),f="number"),null!=c&&c===c&&("number"!==f||m.cssNumber[h]||(c+="px"),k.clearCloneStyle||""!==c||0!==b.indexOf("background")||(i[b]="inherit"),!(g&&"set"in g&&void 0===(c=g.set(a,c,d)))))try{i[b]=c}catch(j){}
}},css:function(a,b,c,d){var e,f,g,h=m.camelCase(b);return b=m.cssProps[h]||(m.cssProps[h]=Ub(a.style,h)),g=m.cssHooks[b]||m.cssHooks[h],g&&"get"in g&&(f=g.get(a,!0,c)),void 0===f&&(f=Jb(a,b,d)),"normal"===f&&b in Sb&&(f=Sb[b]),""===c||c?(e=parseFloat(f),c===!0||m.isNumeric(e)?e||0:f):f}}),m.each(["height","width"],function(a,b){m.cssHooks[b]={get:function(a,c,d){return c?Ob.test(m.css(a,"display"))&&0===a.offsetWidth?m.swap(a,Rb,function(){return Yb(a,b,d)}):Yb(a,b,d):void 0},set:function(a,c,d){var e=d&&Ib(a);return Wb(a,c,d?Xb(a,b,d,k.boxSizing&&"border-box"===m.css(a,"boxSizing",!1,e),e):0)}}}),k.opacity||(m.cssHooks.opacity={get:function(a,b){return Nb.test((b&&a.currentStyle?a.currentStyle.filter:a.style.filter)||"")?.01*parseFloat(RegExp.$1)+"":b?"1":""},set:function(a,b){var c=a.style,d=a.currentStyle,e=m.isNumeric(b)?"alpha(opacity="+100*b+")":"",f=d&&d.filter||c.filter||"";c.zoom=1,(b>=1||""===b)&&""===m.trim(f.replace(Mb,""))&&c.removeAttribute&&(c.removeAttribute("filter
"),""===b||d&&!d.filter)||(c.filter=Mb.test(f)?f.replace(Mb,e):f+" "+e)}}),m.cssHooks.marginRight=Lb(k.reliableMarginRight,function(a,b){return b?m.swap(a,{display:"inline-block"},Jb,[a,"marginRight"]):void 0}),m.each({margin:"",padding:"",border:"Width"},function(a,b){m.cssHooks[a+b]={expand:function(c){for(var d=0,e={},f="string"==typeof c?c.split(" "):[c];4>d;d++)e[a+T[d]+b]=f[d]||f[d-2]||f[0];return e}},Gb.test(a)||(m.cssHooks[a+b].set=Wb)}),m.fn.extend({css:function(a,b){return V(this,function(a,b,c){var d,e,f={},g=0;if(m.isArray(b)){for(d=Ib(a),e=b.length;e>g;g++)f[b[g]]=m.css(a,b[g],!1,d);return f}return void 0!==c?m.style(a,b,c):m.css(a,b)},a,b,arguments.length>1)},show:function(){return Vb(this,!0)},hide:function(){return Vb(this)},toggle:function(a){return"boolean"==typeof a?a?this.show():this.hide():this.each(function(){U(this)?m(this).show():m(this).hide()})}});function Zb(a,b,c,d,e){return new Zb.prototype.init(a,b,c,d,e)}m.Tween=Zb,Zb.prototype={constructor:Zb,init:fun
ction(a,b,c,d,e,f){this.elem=a,this.prop=c,this.easing=e||"swing",this.options=b,this.start=this.now=this.cur(),this.end=d,this.unit=f||(m.cssNumber[c]?"":"px")
-},cur:function(){var a=Zb.propHooks[this.prop];return a&&a.get?a.get(this):Zb.propHooks._default.get(this)},run:function(a){var b,c=Zb.propHooks[this.prop];return this.pos=b=this.options.duration?m.easing[this.easing](a,this.options.duration*a,0,1,this.options.duration):a,this.now=(this.end-this.start)*b+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),c&&c.set?c.set(this):Zb.propHooks._default.set(this),this}},Zb.prototype.init.prototype=Zb.prototype,Zb.propHooks={_default:{get:function(a){var b;return null==a.elem[a.prop]||a.elem.style&&null!=a.elem.style[a.prop]?(b=m.css(a.elem,a.prop,""),b&&"auto"!==b?b:0):a.elem[a.prop]},set:function(a){m.fx.step[a.prop]?m.fx.step[a.prop](a):a.elem.style&&(null!=a.elem.style[m.cssProps[a.prop]]||m.cssHooks[a.prop])?m.style(a.elem,a.prop,a.now+a.unit):a.elem[a.prop]=a.now}}},Zb.propHooks.scrollTop=Zb.propHooks.scrollLeft={set:function(a){a.elem.nodeType&&a.elem.parentNode&&(a.elem[a.prop]=a.now)}},m.easing={linear:fu
nction(a){return a},swing:function(a){return.5-Math.cos(a*Math.PI)/2}},m.fx=Zb.prototype.init,m.fx.step={};var $b,_b,ac=/^(?:toggle|show|hide)$/,bc=new RegExp("^(?:([+-])=|)("+S+")([a-z%]*)$","i"),cc=/queueHooks$/,dc=[ic],ec={"*":[function(a,b){var c=this.createTween(a,b),d=c.cur(),e=bc.exec(b),f=e&&e[3]||(m.cssNumber[a]?"":"px"),g=(m.cssNumber[a]||"px"!==f&&+d)&&bc.exec(m.css(c.elem,a)),h=1,i=20;if(g&&g[3]!==f){f=f||g[3],e=e||[],g=+d||1;do h=h||".5",g/=h,m.style(c.elem,a,g+f);while(h!==(h=c.cur()/d)&&1!==h&&--i)}return e&&(g=c.start=+g||+d||0,c.unit=f,c.end=e[1]?g+(e[1]+1)*e[2]:+e[2]),c}]};function fc(){return setTimeout(function(){$b=void 0}),$b=m.now()}function gc(a,b){var c,d={height:a},e=0;for(b=b?1:0;4>e;e+=2-b)c=T[e],d["margin"+c]=d["padding"+c]=a;return b&&(d.opacity=d.width=a),d}function hc(a,b,c){for(var d,e=(ec[b]||[]).concat(ec["*"]),f=0,g=e.length;g>f;f++)if(d=e[f].call(c,b,a))return d}function ic(a,b,c){var d,e,f,g,h,i,j,l,n=this,o={},p=a.style,q=a.nodeType&&U(a),r=m._
data(a,"fxshow");c.queue||(h=m._queueHooks(a,"fx"),null==h.unqueued&&(h.unqueued=0,i=h.empty.fire,h.empty.fire=function(){h.unqueued||i()}),h.unqueued++,n.always(function(){n.always(function(){h.unqueued--,m.queue(a,"fx").length||h.empty.fire()})})),1===a.nodeType&&("height"in b||"width"in b)&&(c.overflow=[p.overflow,p.overflowX,p.overflowY],j=m.css(a,"display"),l="none"===j?m._data(a,"olddisplay")||Fb(a.nodeName):j,"inline"===l&&"none"===m.css(a,"float")&&(k.inlineBlockNeedsLayout&&"inline"!==Fb(a.nodeName)?p.zoom=1:p.display="inline-block")),c.overflow&&(p.overflow="hidden",k.shrinkWrapBlocks()||n.always(function(){p.overflow=c.overflow[0],p.overflowX=c.overflow[1],p.overflowY=c.overflow[2]}));for(d in b)if(e=b[d],ac.exec(e)){if(delete b[d],f=f||"toggle"===e,e===(q?"hide":"show")){if("show"!==e||!r||void 0===r[d])continue;q=!0}o[d]=r&&r[d]||m.style(a,d)}else j=void 0;if(m.isEmptyObject(o))"inline"===("none"===j?Fb(a.nodeName):j)&&(p.display=j);else{r?"hidden"in r&&(q=r.hidden):r=m
._data(a,"fxshow",{}),f&&(r.hidden=!q),q?m(a).show():n.done(function(){m(a).hide()}),n.done(function(){var b;m._removeData(a,"fxshow");for(b in o)m.style(a,b,o[b])});for(d in o)g=hc(q?r[d]:0,d,n),d in r||(r[d]=g.start,q&&(g.end=g.start,g.start="width"===d||"height"===d?1:0))}}function jc(a,b){var c,d,e,f,g;for(c in a)if(d=m.camelCase(c),e=b[d],f=a[c],m.isArray(f)&&(e=f[1],f=a[c]=f[0]),c!==d&&(a[d]=f,delete a[c]),g=m.cssHooks[d],g&&"expand"in g){f=g.expand(f),delete a[d];for(c in f)c in a||(a[c]=f[c],b[c]=e)}else b[d]=e}function kc(a,b,c){var d,e,f=0,g=dc.length,h=m.Deferred().always(function(){delete i.elem}),i=function(){if(e)return!1;for(var b=$b||fc(),c=Math.max(0,j.startTime+j.duration-b),d=c/j.duration||0,f=1-d,g=0,i=j.tweens.length;i>g;g++)j.tweens[g].run(f);return h.notifyWith(a,[j,f,c]),1>f&&i?c:(h.resolveWith(a,[j]),!1)},j=h.promise({elem:a,props:m.extend({},b),opts:m.extend(!0,{specialEasing:{}},c),originalProperties:b,originalOptions:c,startTime:$b||fc(),duration:c.durati
on,tweens:[],createTween:function(b,c){var d=m.Tween(a,j.opts,b,c,j.opts.specialEasing[b]||j.opts.easing);return j.tweens.push(d),d},stop:function(b){var c=0,d=b?j.tweens.length:0;if(e)return this;for(e=!0;d>c;c++)j.tweens[c].run(1);return b?h.resolveWith(a,[j,b]):h.rejectWith(a,[j,b]),this}}),k=j.props;for(jc(k,j.opts.specialEasing);g>f;f++)if(d=dc[f].call(j,a,k,j.opts))return d;return m.map(k,hc,j),m.isFunction(j.opts.start)&&j.opts.start.call(a,j),m.fx.timer(m.extend(i,{elem:a,anim:j,queue:j.opts.queue})),j.progress(j.opts.progress).done(j.opts.done,j.opts.complete).fail(j.opts.fail).always(j.opts.always)}m.Animation=m.extend(kc,{tweener:function(a,b){m.isFunction(a)?(b=a,a=["*"]):a=a.split(" ");for(var c,d=0,e=a.length;e>d;d++)c=a[d],ec[c]=ec[c]||[],ec[c].unshift(b)},prefilter:function(a,b){b?dc.unshift(a):dc.push(a)}}),m.speed=function(a,b,c){var d=a&&"object"==typeof a?m.extend({},a):{complete:c||!c&&b||m.isFunction(a)&&a,duration:a,easing:c&&b||b&&!m.isFunction(b)&&b};return
d.duration=m.fx.off?0:"number"==typeof d.duration?d.duration:d.duration in m.fx.speeds?m.fx.speeds[d.duration]:m.fx.speeds._default,(null==d.queue||d.queue===!0)&&(d.queue="fx"),d.old=d.complete,d.complete=function(){m.isFunction(d.old)&&d.old.call(this),d.queue&&m.dequeue(this,d.queue)},d},m.fn.extend({fadeTo:function(a,b,c,d){return this.filter(U).css("opacity",0).show().end().animate({opacity:b},a,c,d)},animate:function(a,b,c,d){var e=m.isEmptyObject(a),f=m.speed(b,c,d),g=function(){var b=kc(this,m.extend({},a),f);(e||m._data(this,"finish"))&&b.stop(!0)};return g.finish=g,e||f.queue===!1?this.each(g):this.queue(f.queue,g)},stop:function(a,b,c){var d=function(a){var b=a.stop;delete a.stop,b(c)};return"string"!=typeof a&&(c=b,b=a,a=void 0),b&&a!==!1&&this.queue(a||"fx",[]),this.each(function(){var b=!0,e=null!=a&&a+"queueHooks",f=m.timers,g=m._data(this);if(e)g[e]&&g[e].stop&&d(g[e]);else for(e in g)g[e]&&g[e].stop&&cc.test(e)&&d(g[e]);for(e=f.length;e--;)f[e].elem!==this||null!=a&
&f[e].queue!==a||(f[e].anim.stop(c),b=!1,f.splice(e,1));(b||!c)&&m.dequeue(this,a)})},finish:function(a){return a!==!1&&(a=a||"fx"),this.each(function(){var b,c=m._data(this),d=c[a+"queue"],e=c[a+"queueHooks"],f=m.timers,g=d?d.length:0;for(c.finish=!0,m.queue(this,a,[]),e&&e.stop&&e.stop.call(this,!0),b=f.length;b--;)f[b].elem===this&&f[b].queue===a&&(f[b].anim.stop(!0),f.splice(b,1));for(b=0;g>b;b++)d[b]&&d[b].finish&&d[b].finish.call(this);delete c.finish})}}),m.each(["toggle","show","hide"],function(a,b){var c=m.fn[b];m.fn[b]=function(a,d,e){return null==a||"boolean"==typeof a?c.apply(this,arguments):this.animate(gc(b,!0),a,d,e)}}),m.each({slideDown:gc("show"),slideUp:gc("hide"),slideToggle:gc("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){m.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),m.timers=[],m.fx.tick=function(){var a,b=m.timers,c=0;for($b=m.now();c<b.length;c++)a=b[c],a()||b[c]!==a||b.splice(c--,1);b.length|
|m.fx.stop(),$b=void 0},m.fx.timer=function(a){m.timers.push(a),a()?m.fx.start():m.timers.pop()},m.fx.interval=13,m.fx.start=function(){_b||(_b=setInterval(m.fx.tick,m.fx.interval))},m.fx.stop=function(){clearInterval(_b),_b=null},m.fx.speeds={slow:600,fast:200,_default:400},m.fn.delay=function(a,b){return a=m.fx?m.fx.speeds[a]||a:a,b=b||"fx",this.queue(b,function(b,c){var d=setTimeout(b,a);c.stop=function(){clearTimeout(d)}})},function(){var a,b,c,d,e;b=y.createElement("div"),b.setAttribute("className","t"),b.innerHTML=" <link/><table></table><a href='/a'>a</a><input type='checkbox'/>",d=b.getElementsByTagName("a")[0],c=y.createElement("select"),e=c.appendChild(y.createElement("option")),a=b.getElementsByTagName("input")[0],d.style.cssText="top:1px",k.getSetAttribute="t"!==b.className,k.style=/top/.test(d.getAttribute("style")),k.hrefNormalized="/a"===d.getAttribute("href"),k.checkOn=!!a.value,k.optSelected=e.selected,k.enctype=!!y.createElement("form").enctype,c.disabled=!0,k.opt
Disabled=!e.disabled,a=y.createElement("input"),a.setAttribute("value",""),k.input=""===a.getAttribute("value"),a.value="t",a.setAttribute("type","radio"),k.radioValue="t"===a.value}();var lc=/\r/g;m.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=m.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,m(this).val()):a,null==e?e="":"number"==typeof e?e+="":m.isArray(e)&&(e=m.map(e,function(a){return null==a?"":a+""})),b=m.valHooks[this.type]||m.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=m.valHooks[e.type]||m.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(lc,""):null==c?"":c)}}}),m.extend({valHooks:{option:{get:function(a){var b=m.find.attr(a,"value");return null!=b?b:m.trim(m.text(a))}},select:{get:function(a){for(var b,c,d=a.options,e=a.selectedIndex,f="select-one"===a.type||0>e,g=f?
null:[],h=f?e+1:d.length,i=0>e?h:f?e:0;h>i;i++)if(c=d[i],!(!c.selected&&i!==e||(k.optDisabled?c.disabled:null!==c.getAttribute("disabled"))||c.parentNode.disabled&&m.nodeName(c.parentNode,"optgroup"))){if(b=m(c).val(),f)return b;g.push(b)}return g},set:function(a,b){var c,d,e=a.options,f=m.makeArray(b),g=e.length;while(g--)if(d=e[g],m.inArray(m.valHooks.option.get(d),f)>=0)try{d.selected=c=!0}catch(h){d.scrollHeight}else d.selected=!1;return c||(a.selectedIndex=-1),e}}}}),m.each(["radio","checkbox"],function(){m.valHooks[this]={set:function(a,b){return m.isArray(b)?a.checked=m.inArray(m(a).val(),b)>=0:void 0}},k.checkOn||(m.valHooks[this].get=function(a){return null===a.getAttribute("value")?"on":a.value})});var mc,nc,oc=m.expr.attrHandle,pc=/^(?:checked|selected)$/i,qc=k.getSetAttribute,rc=k.input;m.fn.extend({attr:function(a,b){return V(this,m.attr,a,b,arguments.length>1)},removeAttr:function(a){return this.each(function(){m.removeAttr(this,a)})}}),m.extend({attr:function(a,b,c){v
ar d,e,f=a.nodeType;if(a&&3!==f&&8!==f&&2!==f)return typeof a.getAttribute===K?m.prop(a,b,c):(1===f&&m.isXMLDoc(a)||(b=b.toLowerCase(),d=m.attrHooks[b]||(m.expr.match.bool.test(b)?nc:mc)),void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=m.find.attr(a,b),null==e?void 0:e):null!==c?d&&"set"in d&&void 0!==(e=d.set(a,c,b))?e:(a.setAttribute(b,c+""),c):void m.removeAttr(a,b))},removeAttr:function(a,b){var c,d,e=0,f=b&&b.match(E);if(f&&1===a.nodeType)while(c=f[e++])d=m.propFix[c]||c,m.expr.match.bool.test(c)?rc&&qc||!pc.test(c)?a[d]=!1:a[m.camelCase("default-"+c)]=a[d]=!1:m.attr(a,c,""),a.removeAttribute(qc?c:d)},attrHooks:{type:{set:function(a,b){if(!k.radioValue&&"radio"===b&&m.nodeName(a,"input")){var c=a.value;return a.setAttribute("type",b),c&&(a.value=c),b}}}}}),nc={set:function(a,b,c){return b===!1?m.removeAttr(a,c):rc&&qc||!pc.test(c)?a.setAttribute(!qc&&m.propFix[c]||c,c):a[m.camelCase("default-"+c)]=a[c]=!0,c}},m.each(m.expr.match.bool.source.match(/\w+/g),function(a,b){var c
=oc[b]||m.find.attr;oc[b]=rc&&qc||!pc.test(b)?function(a,b,d){var e,f;return d||(f=oc[b],oc[b]=e,e=null!=c(a,b,d)?b.toLowerCase():null,oc[b]=f),e}:function(a,b,c){return c?void 0:a[m.camelCase("default-"+b)]?b.toLowerCase():null}}),rc&&qc||(m.attrHooks.value={set:function(a,b,c){return m.nodeName(a,"input")?void(a.defaultValue=b):mc&&mc.set(a,b,c)}}),qc||(mc={set:function(a,b,c){var d=a.getAttributeNode(c);return d||a.setAttributeNode(d=a.ownerDocument.createAttribute(c)),d.value=b+="","value"===c||b===a.getAttribute(c)?b:void 0}},oc.id=oc.name=oc.coords=function(a,b,c){var d;return c?void 0:(d=a.getAttributeNode(b))&&""!==d.value?d.value:null},m.valHooks.button={get:function(a,b){var c=a.getAttributeNode(b);return c&&c.specified?c.value:void 0},set:mc.set},m.attrHooks.contenteditable={set:function(a,b,c){mc.set(a,""===b?!1:b,c)}},m.each(["width","height"],function(a,b){m.attrHooks[b]={set:function(a,c){return""===c?(a.setAttribute(b,"auto"),c):void 0}}})),k.style||(m.attrHooks.styl
e={get:function(a){return a.style.cssText||void 0},set:function(a,b){return a.style.cssText=b+""}});var sc=/^(?:input|select|textarea|button|object)$/i,tc=/^(?:a|area)$/i;m.fn.extend({prop:function(a,b){return V(this,m.prop,a,b,arguments.length>1)},removeProp:function(a){return a=m.propFix[a]||a,this.each(function(){try{this[a]=void 0,delete this[a]}catch(b){}})}}),m.extend({propFix:{"for":"htmlFor","class":"className"},prop:function(a,b,c){var d,e,f,g=a.nodeType;if(a&&3!==g&&8!==g&&2!==g)return f=1!==g||!m.isXMLDoc(a),f&&(b=m.propFix[b]||b,e=m.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){var b=m.find.attr(a,"tabindex");return b?parseInt(b,10):sc.test(a.nodeName)||tc.test(a.nodeName)&&a.href?0:-1}}}}),k.hrefNormalized||m.each(["href","src"],function(a,b){m.propHooks[b]={get:function(a){return a.getAttribute(b,4)}}}),k.optSelected||(m.propHooks.selected={get:function(a){var b
=a.parentNode;return b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex),null}}),m.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){m.propFix[this.toLowerCase()]=this}),k.enctype||(m.propFix.enctype="encoding");var uc=/[\t\r\n\f]/g;m.fn.extend({addClass:function(a){var b,c,d,e,f,g,h=0,i=this.length,j="string"==typeof a&&a;if(m.isFunction(a))return this.each(function(b){m(this).addClass(a.call(this,b,this.className))});if(j)for(b=(a||"").match(E)||[];i>h;h++)if(c=this[h],d=1===c.nodeType&&(c.className?(" "+c.className+" ").replace(uc," "):" ")){f=0;while(e=b[f++])d.indexOf(" "+e+" ")<0&&(d+=e+" ");g=m.trim(d),c.className!==g&&(c.className=g)}return this},removeClass:function(a){var b,c,d,e,f,g,h=0,i=this.length,j=0===arguments.length||"string"==typeof a&&a;if(m.isFunction(a))return this.each(function(b){m(this).removeClass(a.call(this,b,this.className))});if(j)for(b=(a||"").match(E)|
|[];i>h;h++)if(c=this[h],d=1===c.nodeType&&(c.className?(" "+c.className+" ").replace(uc," "):"")){f=0;while(e=b[f++])while(d.indexOf(" "+e+" ")>=0)d=d.replace(" "+e+" "," ");g=a?m.trim(d):"",c.className!==g&&(c.className=g)}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):this.each(m.isFunction(a)?function(c){m(this).toggleClass(a.call(this,c,this.className,b),b)}:function(){if("string"===c){var b,d=0,e=m(this),f=a.match(E)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else(c===K||"boolean"===c)&&(this.className&&m._data(this,"__className__",this.className),this.className=this.className||a===!1?"":m._data(this,"__className__")||"")})},hasClass:function(a){for(var b=" "+a+" ",c=0,d=this.length;d>c;c++)if(1===this[c].nodeType&&(" "+this[c].className+" ").replace(uc," ").indexOf(b)>=0)return!0;return!1}}),m.each("blur focus focusin focusout load resize scroll unload click dblclick mou
sedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup error contextmenu".split(" "),function(a,b){m.fn[b]=function(a,c){return arguments.length>0?this.on(b,null,a,c):this.trigger(b)}}),m.fn.extend({hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)},bind:function(a,b,c){return this.on(a,null,b,c)},unbind:function(a,b){return this.off(a,null,b)},delegate:function(a,b,c,d){return this.on(b,a,c,d)},undelegate:function(a,b,c){return 1===arguments.length?this.off(a,"**"):this.off(b,a||"**",c)}});var vc=m.now(),wc=/\?/,xc=/(,)|(\[|{)|(}|])|"(?:[^"\\\r\n]|\\["\\\/bfnrt]|\\u[\da-fA-F]{4})*"\s*:?|true|false|null|-?(?!0\d)\d+(?:\.\d+|)(?:[eE][+-]?\d+|)/g;m.parseJSON=function(b){if(a.JSON&&a.JSON.parse)return a.JSON.parse(b+"");var c,d=null,e=m.trim(b+"");return e&&!m.trim(e.replace(xc,function(a,b,e,f){return c&&b&&(d=0),0===d?a:(c=e||b,d+=!f-!e,"")}))?Function("return "+e)():m.error("Invalid JSON: "+b)},m.parseXML=function(b
){var c,d;if(!b||"string"!=typeof b)return null;try{a.DOMParser?(d=new DOMParser,c=d.parseFromString(b,"text/xml")):(c=new ActiveXObject("Microsoft.XMLDOM"),c.async="false",c.loadXML(b))}catch(e){c=void 0}return c&&c.documentElement&&!c.getElementsByTagName("parsererror").length||m.error("Invalid XML: "+b),c};var yc,zc,Ac=/#.*$/,Bc=/([?&])_=[^&]*/,Cc=/^(.*?):[ \t]*([^\r\n]*)\r?$/gm,Dc=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,Ec=/^(?:GET|HEAD)$/,Fc=/^\/\//,Gc=/^([\w.+-]+:)(?:\/\/(?:[^\/?#]*@|)([^\/?#:]*)(?::(\d+)|)|)/,Hc={},Ic={},Jc="*/".concat("*");try{zc=location.href}catch(Kc){zc=y.createElement("a"),zc.href="",zc=zc.href}yc=Gc.exec(zc.toLowerCase())||[];function Lc(a){return function(b,c){"string"!=typeof b&&(c=b,b="*");var d,e=0,f=b.toLowerCase().match(E)||[];if(m.isFunction(c))while(d=f[e++])"+"===d.charAt(0)?(d=d.slice(1)||"*",(a[d]=a[d]||[]).unshift(c)):(a[d]=a[d]||[]).push(c)}}function Mc(a,b,c,d){var e={},f=a===Ic;function g(h){var i;return e[h]=!0,m.each
(a[h]||[],function(a,h){var j=h(b,c,d);return"string"!=typeof j||f||e[j]?f?!(i=j):void 0:(b.dataTypes.unshift(j),g(j),!1)}),i}return g(b.dataTypes[0])||!e["*"]&&g("*")}function Nc(a,b){var c,d,e=m.ajaxSettings.flatOptions||{};for(d in b)void 0!==b[d]&&((e[d]?a:c||(c={}))[d]=b[d]);return c&&m.extend(!0,a,c),a}function Oc(a,b,c){var d,e,f,g,h=a.contents,i=a.dataTypes;while("*"===i[0])i.shift(),void 0===e&&(e=a.mimeType||b.getResponseHeader("Content-Type"));if(e)for(g in h)if(h[g]&&h[g].test(e)){i.unshift(g);break}if(i[0]in c)f=i[0];else{for(g in c){if(!i[0]||a.converters[g+" "+i[0]]){f=g;break}d||(d=g)}f=f||d}return f?(f!==i[0]&&i.unshift(f),c[f]):void 0}function Pc(a,b,c,d){var e,f,g,h,i,j={},k=a.dataTypes.slice();if(k[1])for(g in a.converters)j[g.toLowerCase()]=a.converters[g];f=k.shift();while(f)if(a.responseFields[f]&&(c[a.responseFields[f]]=b),!i&&d&&a.dataFilter&&(b=a.dataFilter(b,a.dataType)),i=f,f=k.shift())if("*"===f)f=i;else if("*"!==i&&i!==f){if(g=j[i+" "+f]||j["* "+f],!g)f
or(e in j)if(h=e.split(" "),h[1]===f&&(g=j[i+" "+h[0]]||j["* "+h[0]])){g===!0?g=j[e]:j[e]!==!0&&(f=h[0],k.unshift(h[1]));break}if(g!==!0)if(g&&a["throws"])b=g(b);else try{b=g(b)}catch(l){return{state:"parsererror",error:g?l:"No conversion from "+i+" to "+f}}}return{state:"success",data:b}}m.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:zc,type:"GET",isLocal:Dc.test(yc[1]),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":Jc,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":m.parseJSON,"text xml":m.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(a,b){return b?Nc(Nc(a,m.ajaxSettings),b):Nc(m.ajaxSettings,a)},ajaxPrefilter:Lc(Hc),ajaxTransport:Lc(Ic),ajax:function(a,b){"
object"==typeof a&&(b=a,a=void 0),b=b||{};var c,d,e,f,g,h,i,j,k=m.ajaxSetup({},b),l=k.context||k,n=k.context&&(l.nodeType||l.jquery)?m(l):m.event,o=m.Deferred(),p=m.Callbacks("once memory"),q=k.statusCode||{},r={},s={},t=0,u="canceled",v={readyState:0,getResponseHeader:function(a){var b;if(2===t){if(!j){j={};while(b=Cc.exec(f))j[b[1].toLowerCase()]=b[2]}b=j[a.toLowerCase()]}return null==b?null:b},getAllResponseHeaders:function(){return 2===t?f:null},setRequestHeader:function(a,b){var c=a.toLowerCase();return t||(a=s[c]=s[c]||a,r[a]=b),this},overrideMimeType:function(a){return t||(k.mimeType=a),this},statusCode:function(a){var b;if(a)if(2>t)for(b in a)q[b]=[q[b],a[b]];else v.always(a[v.status]);return this},abort:function(a){var b=a||u;return i&&i.abort(b),x(0,b),this}};if(o.promise(v).complete=p.add,v.success=v.done,v.error=v.fail,k.url=((a||k.url||zc)+"").replace(Ac,"").replace(Fc,yc[1]+"//"),k.type=b.method||b.type||k.method||k.type,k.dataTypes=m.trim(k.dataType||"*").toLowerCase(
).match(E)||[""],null==k.crossDomain&&(c=Gc.exec(k.url.toLowerCase()),k.crossDomain=!(!c||c[1]===yc[1]&&c[2]===yc[2]&&(c[3]||("http:"===c[1]?"80":"443"))===(yc[3]||("http:"===yc[1]?"80":"443")))),k.data&&k.processData&&"string"!=typeof k.data&&(k.data=m.param(k.data,k.traditional)),Mc(Hc,k,b,v),2===t)return v;h=k.global,h&&0===m.active++&&m.event.trigger("ajaxStart"),k.type=k.type.toUpperCase(),k.hasContent=!Ec.test(k.type),e=k.url,k.hasContent||(k.data&&(e=k.url+=(wc.test(e)?"&":"?")+k.data,delete k.data),k.cache===!1&&(k.url=Bc.test(e)?e.replace(Bc,"$1_="+vc++):e+(wc.test(e)?"&":"?")+"_="+vc++)),k.ifModified&&(m.lastModified[e]&&v.setRequestHeader("If-Modified-Since",m.lastModified[e]),m.etag[e]&&v.setRequestHeader("If-None-Match",m.etag[e])),(k.data&&k.hasContent&&k.contentType!==!1||b.contentType)&&v.setRequestHeader("Content-Type",k.contentType),v.setRequestHeader("Accept",k.dataTypes[0]&&k.accepts[k.dataTypes[0]]?k.accepts[k.dataTypes[0]]+("*"!==k.dataTypes[0]?", "+Jc+"; q=0.0
1":""):k.accepts["*"]);for(d in k.headers)v.setRequestHeader(d,k.headers[d]);if(k.beforeSend&&(k.beforeSend.call(l,v,k)===!1||2===t))return v.abort();u="abort";for(d in{success:1,error:1,complete:1})v[d](k[d]);if(i=Mc(Ic,k,b,v)){v.readyState=1,h&&n.trigger("ajaxSend",[v,k]),k.async&&k.timeout>0&&(g=setTimeout(function(){v.abort("timeout")},k.timeout));try{t=1,i.send(r,x)}catch(w){if(!(2>t))throw w;x(-1,w)}}else x(-1,"No Transport");function x(a,b,c,d){var j,r,s,u,w,x=b;2!==t&&(t=2,g&&clearTimeout(g),i=void 0,f=d||"",v.readyState=a>0?4:0,j=a>=200&&300>a||304===a,c&&(u=Oc(k,v,c)),u=Pc(k,u,v,j),j?(k.ifModified&&(w=v.getResponseHeader("Last-Modified"),w&&(m.lastModified[e]=w),w=v.getResponseHeader("etag"),w&&(m.etag[e]=w)),204===a||"HEAD"===k.type?x="nocontent":304===a?x="notmodified":(x=u.state,r=u.data,s=u.error,j=!s)):(s=x,(a||!x)&&(x="error",0>a&&(a=0))),v.status=a,v.statusText=(b||x)+"",j?o.resolveWith(l,[r,x,v]):o.rejectWith(l,[v,x,s]),v.statusCode(q),q=void 0,h&&n.trigger(j?"ajax
Success":"ajaxError",[v,k,j?r:s]),p.fireWith(l,[v,x]),h&&(n.trigger("ajaxComplete",[v,k]),--m.active||m.event.trigger("ajaxStop")))}return v},getJSON:function(a,b,c){return m.get(a,b,c,"json")},getScript:function(a,b){return m.get(a,void 0,b,"script")}}),m.each(["get","post"],function(a,b){m[b]=function(a,c,d,e){return m.isFunction(c)&&(e=e||d,d=c,c=void 0),m.ajax({url:a,type:b,dataType:e,data:c,success:d})}}),m.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(a,b){m.fn[b]=function(a){return this.on(b,a)}}),m._evalUrl=function(a){return m.ajax({url:a,type:"GET",dataType:"script",async:!1,global:!1,"throws":!0})},m.fn.extend({wrapAll:function(a){if(m.isFunction(a))return this.each(function(b){m(this).wrapAll(a.call(this,b))});if(this[0]){var b=m(a,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstChild&&1===a.firstChild.nodeType)a=a.firstChild;return a}).append(this)}re
turn this},wrapInner:function(a){return this.each(m.isFunction(a)?function(b){m(this).wrapInner(a.call(this,b))}:function(){var b=m(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=m.isFunction(a);return this.each(function(c){m(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(){return this.parent().each(function(){m.nodeName(this,"body")||m(this).replaceWith(this.childNodes)}).end()}}),m.expr.filters.hidden=function(a){return a.offsetWidth<=0&&a.offsetHeight<=0||!k.reliableHiddenOffsets()&&"none"===(a.style&&a.style.display||m.css(a,"display"))},m.expr.filters.visible=function(a){return!m.expr.filters.hidden(a)};var Qc=/%20/g,Rc=/\[\]$/,Sc=/\r?\n/g,Tc=/^(?:submit|button|image|reset|file)$/i,Uc=/^(?:input|select|textarea|keygen)/i;function Vc(a,b,c,d){var e;if(m.isArray(b))m.each(b,function(b,e){c||Rc.test(a)?d(a,e):Vc(a+"["+("object"==typeof e?b:"")+"]",e,c,d)});else if(c||"object"!==m.type(b))d(a,b);else for(e in b)Vc(a+"["+e+"]",b[e],c,d)}m.para
m=function(a,b){var c,d=[],e=function(a,b){b=m.isFunction(b)?b():null==b?"":b,d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(b)};if(void 0===b&&(b=m.ajaxSettings&&m.ajaxSettings.traditional),m.isArray(a)||a.jquery&&!m.isPlainObject(a))m.each(a,function(){e(this.name,this.value)});else for(c in a)Vc(c,a[c],b,e);return d.join("&").replace(Qc,"+")},m.fn.extend({serialize:function(){return m.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var a=m.prop(this,"elements");return a?m.makeArray(a):this}).filter(function(){var a=this.type;return this.name&&!m(this).is(":disabled")&&Uc.test(this.nodeName)&&!Tc.test(a)&&(this.checked||!W.test(a))}).map(function(a,b){var c=m(this).val();return null==c?null:m.isArray(c)?m.map(c,function
<TRUNCATED>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/undocumented.txt
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/undocumented.txt b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/undocumented.txt
deleted file mode 100644
index e69de29..0000000
[20/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClientConfig.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClientConfig.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClientConfig.html
deleted file mode 100644
index b7abeab..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClientConfig.html
+++ /dev/null
@@ -1,744 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridClientConfig 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/UsergridClientConfig" class="dashAnchor"></a>
- <a title="UsergridClientConfig 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" />
- UsergridClientConfig 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>UsergridClientConfig</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClientConfig</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridClientConfig</code> is used when initializing <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> objects.</p>
-
-<p>The <code>UsergridClientConfig</code> is meant for further customization of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> objects when needed.</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:vC11UsergridSDK20UsergridClientConfig5orgIdSS"></a>
- <a name="//apple_ref/swift/Property/orgId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig5orgIdSS">orgId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The organization identifier.</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">orgId</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:vC11UsergridSDK20UsergridClientConfig5appIdSS"></a>
- <a name="//apple_ref/swift/Property/appId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig5appIdSS">appId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application identifier.</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">appId</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:vC11UsergridSDK20UsergridClientConfig7baseUrlSS"></a>
- <a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig7baseUrlSS">baseUrl</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The base URL that all calls will be made with.</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">baseUrl</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt">UsergridClient</span><span class="o">.</span><span class="kt">DEFAULT_BASE_URL</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK20UsergridClientConfig8authModeOS_16UsergridAuthMode"></a>
- <a name="//apple_ref/swift/Property/authMode" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig8authModeOS_16UsergridAuthMode">authMode</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent, if any.</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">authMode</span><span class="p">:</span> <span class="kt">UsergridAuthMode</span> <span class="o">=</span> <span class="o">.</span><span class="kt">User</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK20UsergridClientConfig28persistCurrentUserInKeychainSb"></a>
- <a name="//apple_ref/swift/Property/persistCurrentUserInKeychain" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Whether or not the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> current user will be saved and restored from the keychain.</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">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK20UsergridClientConfig7appAuthGSqCS_15UsergridAppAuth_"></a>
- <a name="//apple_ref/swift/Property/appAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig7appAuthGSqCS_15UsergridAppAuth_">appAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application level <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object.</p>
-
-<p>Note that you still need to call the authentication methods within <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> once it has been initialized.</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">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</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:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS_S0_">init(orgId:appId:)</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/UsergridClientConfig.html">UsergridClientConfig</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</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>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:baseUrl:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS_S0_">init(orgId:appId:baseUrl:)</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/UsergridClientConfig.html">UsergridClientConfig</a></code>.</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">baseUrl</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>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>baseUrl</em>
- </code>
- </td>
- <td>
- <div>
- <p>The base URL that all calls will be made with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS8authModeOS_16UsergridAuthMode28persistCurrentUserInKeychainSb7appAuthGSqCS_15UsergridAppAuth__S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:baseUrl:authMode:persistCurrentUserInKeychain:appAuth:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS8authModeOS_16UsergridAuthMode28persistCurrentUserInKeychainSb7appAuthGSqCS_15UsergridAppAuth__S0_">init(orgId:appId:baseUrl:authMode:persistCurrentUserInKeychain:appAuth:)</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/UsergridClientConfig.html">UsergridClientConfig</a></code>.</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</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">authMode</span><span class="p">:</span><span class="kt">UsergridAuthMode</span><span class="p">,</span> <span class="nv">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">appAuth</span><span class="p">:</span><span class="kt">UsergridAppAuth</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</s
pan></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>baseUrl</em>
- </code>
- </td>
- <td>
- <div>
- <p>The base URL that all calls will be made with.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>authMode</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAuthMode</code> value used to determine what type of token will be sent, if any.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>persistCurrentUserInKeychain</em>
- </code>
- </td>
- <td>
- <div>
- <p>Whether or not the <code>UsergridClient</code> current user will be saved and restored from the keychain.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appAuth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application level <code>UsergridAppAuth</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</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:FC11UsergridSDK20UsergridClientConfigcFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5coderCSo7NSCoder_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">public</span> <span class="kd">required</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:FC11UsergridSDK20UsergridClientConfig15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfig15encodeWithCoderFCSo7NSCoderT_">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/UsergridDevice.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridDevice.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridDevice.html
deleted file mode 100644
index 9cda8aa..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridDevice.html
+++ /dev/null
@@ -1,763 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridDevice 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/UsergridDevice" class="dashAnchor"></a>
- <a title="UsergridDevice 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" />
- UsergridDevice 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>UsergridDevice</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridDevice</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridDevice</code> is an <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> subclass that encapsulates information about the current device as well as stores information about push tokens and Usergrid notifiers.</p>
-
-<p>To apply push tokens for Usergrid notifiers use the <code>UsergridClient.applyPushToken</code> method.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:iC11UsergridSDK14UsergridDevice9subscriptFSSGSqPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:iC11UsergridSDK14UsergridDevice9subscriptFSSGSqPs9AnyObject__">subscript(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Subscript for the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> class. Note that all of the <code><a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a></code> are immutable.</p>
-
-<div class="aside aside-warning">
- <p class="aside-title">Warning</p>
- <p>When setting a properties value must be a valid JSON object.</p>
-
-</div>
-
-<p><li><p>Example usage:
-<code>
-let uuid = usergridDevice["uuid"]
-</code></p></li></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="nf">subscript</span><span class="p">(</span><span class="nv">propertyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AnyObject</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="/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:vC11UsergridSDK14UsergridDevice5modelSS"></a>
- <a name="//apple_ref/swift/Property/model" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridDevice5modelSS">model</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> objects device model.</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">model</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">super</span><span class="p">[</span><span class="kt">UsergridDeviceProperties</span><span class="o">.</span><span class="kt">Model</span><span class="o">.</span><span class="n">stringValue</span><span class="p">]</span> <span class="k">as!</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:vC11UsergridSDK14UsergridDevice8platformSS"></a>
- <a name="//apple_ref/swift/Property/platform" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridDevice8platformSS">platform</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> objects device platform.</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">platform</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">super</span><span class="p">[</span><span class="kt">UsergridDeviceProperties</span><span class="o">.</span><span class="kt">Platform</span><span class="o">.</span><span class="n">stringValue</span><span class="p">]</span> <span class="k">as!</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:vC11UsergridSDK14UsergridDevice9osVersionSS"></a>
- <a name="//apple_ref/swift/Property/osVersion" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridDevice9osVersionSS">osVersion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> objects device operating system version.</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">osVersion</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">super</span><span class="p">[</span><span class="kt">UsergridDeviceProperties</span><span class="o">.</span><span class="kt">OSVersion</span><span class="o">.</span><span class="n">stringValue</span><span class="p">]</span> <span class="k">as!</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:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_"></a>
- <a name="//apple_ref/swift/Variable/sharedDevice" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">sharedDevice</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The shared instance of <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">sharedDevice</span><span class="p">:</span> <span class="kt">UsergridDevice</span> <span class="o">=</span> <span class="kt">UsergridDevice</span><span class="o">.</span><span class="nf">getOrCreateSharedDeviceFromKeychain</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:FC11UsergridSDK14UsergridDevicecFT_S0_"></a>
- <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevicecFT_S0_">init()</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/UsergridDevice.html">UsergridDevice</a></code> objects</p>
-
-<p>Most likely you will never need to create seperate instances of <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code>. Use of <code>UsergridDevice.sharedInstance</code> is recommended.</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></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridDevicecFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a>
- <a name="//apple_ref/swift/Method/init(type:name:propertyDict:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevicecFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_">init(type:name:propertyDict:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The required public initializer for <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> subclasses.</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="nv">type</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">propertyDict</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></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The type associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional name associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>propertyDict</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional property dictionary that the <code>UsergridEntity</code> object will start out with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> object.</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:FC11UsergridSDK14UsergridDevicecFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevicecFT5coderCSo7NSCoder_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:FC11UsergridSDK14UsergridDevice15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevice15encodeWithCoderFCSo7NSCoderT_">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="k">override</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>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridDevice4saveFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/save(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevice4saveFTGSqFT8responseCS_16UsergridResponse_T___T_">save(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a PUT (or POST if no UUID is found) on the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
-<p>If this device is equal to <code><a href="../Classes/UsergridDevice.html#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">UsergridDevice.sharedDevice</a></code> it will also update the shared device on the keychain.</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">override</span> <span class="kd">func</span> <span class="nf">save</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the updated/saved <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridDevice4saveFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/save(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevice4saveFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">save(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a PUT (or POST if no UUID is found) on the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code>.</p>
-
-<p>If this device is equal to <code><a href="../Classes/UsergridDevice.html#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">UsergridDevice.sharedDevice</a></code> it will also update the shared device on the keychain.</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">override</span> <span class="kd">func</span> <span class="nf">save</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use when saving.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the updated/saved <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK14UsergridDevice26saveSharedDeviceToKeychainFT_T_"></a>
- <a name="//apple_ref/swift/Method/saveSharedDeviceToKeychain()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK14UsergridDevice26saveSharedDeviceToKeychainFT_T_">saveSharedDeviceToKeychain()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Saves the <code><a href="../Classes/UsergridDevice.html#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">UsergridDevice.sharedDevice</a></code> to the keychain.</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">static</span> <span class="kd">func</span> <span class="nf">saveSharedDeviceToKeychain</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="/Class%20Helper%20Methods"></a>
- <a name="//apple_ref/swift/Section/Class Helper Methods" class="dashAnchor"></a>
- <a href="#/Class%20Helper%20Methods">
- <h3 class="section-name">Class Helper Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK14UsergridDevice24commonDevicePropertyDictFT_GVs10DictionarySSPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Method/commonDevicePropertyDict()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK14UsergridDevice24commonDevicePropertyDictFT_GVs10DictionarySSPs9AnyObject__">commonDevicePropertyDict()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a property dictionary that contains the common properties for <code><a href="../Classes/UsergridDevice.html">UsergridDevice</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="kd">static</span> <span class="kd">func</span> <span class="nf">commonDevicePropertyDict</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">]</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A property dictionary with the common properties set.</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>
[31/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridUser/UsergridUserProperties.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridUser/UsergridUserProperties.html b/sdks/swift/docs/Classes/UsergridUser/UsergridUserProperties.html
deleted file mode 100644
index e6c7cf6..0000000
--- a/sdks/swift/docs/Classes/UsergridUser/UsergridUserProperties.html
+++ /dev/null
@@ -1,346 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridUserProperties Enum 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/Enum/UsergridUserProperties" class="dashAnchor"></a>
- <a title="UsergridUserProperties Enum Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../../index.html"> Docs</a> (43% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../../index.html"> Reference</a>
- <img id="carat" src="../../img/carat.png" />
- UsergridUserProperties Enum 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/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/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/UsergridResponse.html">UsergridResponse</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="../../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="../../Extensions/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../../Protocols/UsergridAuth.html">UsergridAuth</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridUserProperties</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties4NameFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Name" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties4NameFMS1_S1_">Name</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8UsernameFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Username" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8UsernameFMS1_S1_">Username</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8PasswordFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Password" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8PasswordFMS1_S1_">Password</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties5EmailFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Email" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties5EmailFMS1_S1_">Email</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties3AgeFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Age" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties3AgeFMS1_S1_">Age</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties9ActivatedFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Activated" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties9ActivatedFMS1_S1_">Activated</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8DisabledFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Disabled" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8DisabledFMS1_S1_">Disabled</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties7PictureFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Picture" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties7PictureFMS1_S1_">Picture</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFOC11UsergridSDK12UsergridUser22UsergridUserProperties10fromStringFMS1_FSSGSqS1__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFOC11UsergridSDK12UsergridUser22UsergridUserProperties10fromStringFMS1_FSSGSqS1__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vOC11UsergridSDK12UsergridUser22UsergridUserProperties11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vOC11UsergridSDK12UsergridUser22UsergridUserProperties11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-20)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/Classes/UsergridUserAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridUserAuth.html b/sdks/swift/docs/Classes/UsergridUserAuth.html
deleted file mode 100644
index 15b46fb..0000000
--- a/sdks/swift/docs/Classes/UsergridUserAuth.html
+++ /dev/null
@@ -1,410 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridUserAuth 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/UsergridUserAuth" class="dashAnchor"></a>
- <a title="UsergridUserAuth 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" />
- UsergridUserAuth 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>UsergridUserAuth</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridUserAuth</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 user 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:vC11UsergridSDK16UsergridUserAuth8usernameSS"></a>
- <a name="//apple_ref/swift/Property/username" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridUserAuth8usernameSS">username</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The username associated with the User.</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">username</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:FC11UsergridSDK16UsergridUserAuthcFT8usernameSS8passwordSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(username:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridUserAuthcFT8usernameSS8passwordSS_S0_">init(username:password:)</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/UsergridUserAuth.html">UsergridUserAuth</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">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username associated with the User.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The password associated with the User.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</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:FC11UsergridSDK16UsergridUserAuthcFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridUserAuthcFT5coderCSo7NSCoder_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/UsergridUserAuth.html">UsergridUserAuth</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK16UsergridUserAuth15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridUserAuth15encodeWithCoderFCSo7NSCoderT_">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/Enums.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums.html b/sdks/swift/docs/Enums.html
deleted file mode 100644
index 56fabb8..0000000
--- a/sdks/swift/docs/Enums.html
+++ /dev/null
@@ -1,435 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Enums 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 title="Enums 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" />
- Enums 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>Enums</h1>
- <p>The following enums are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK16UsergridAuthMode"></a>
- <a name="//apple_ref/swift/Enum/UsergridAuthMode" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK16UsergridAuthMode">UsergridAuthMode</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>An enumeration that is used to determine what the <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> will use for authorization.</p>
-
- <a href="Enums/UsergridAuthMode.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridAuthMode</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK24UsergridEntityProperties"></a>
- <a name="//apple_ref/swift/Enum/UsergridEntityProperties" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK24UsergridEntityProperties">UsergridEntityProperties</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p>
-
- <a href="Enums/UsergridEntityProperties.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridEntityProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK24UsergridDeviceProperties"></a>
- <a name="//apple_ref/swift/Enum/UsergridDeviceProperties" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK24UsergridDeviceProperties">UsergridDeviceProperties</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridDeviceProperties</code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p>
-
- <a href="Enums/UsergridDeviceProperties.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridDeviceProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK22UsergridUserProperties"></a>
- <a name="//apple_ref/swift/Enum/UsergridUserProperties" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK22UsergridUserProperties">UsergridUserProperties</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Classes/UsergridUser.html">UsergridUser</a></code> specific properties keys.</p>
-
- <a href="Enums/UsergridUserProperties.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridUserProperties</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK21UsergridQueryOperator"></a>
- <a name="//apple_ref/swift/Enum/UsergridQueryOperator" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK21UsergridQueryOperator">UsergridQueryOperator</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Classes/UsergridQuery.html">UsergridQuery</a></code> specific operators.</p>
-
- <a href="Enums/UsergridQueryOperator.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridQueryOperator</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK22UsergridQuerySortOrder"></a>
- <a name="//apple_ref/swift/Enum/UsergridQuerySortOrder" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK22UsergridQuerySortOrder">UsergridQuerySortOrder</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Classes/UsergridQuery.html">UsergridQuery</a></code> specific sort orders.</p>
-
- <a href="Enums/UsergridQuerySortOrder.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridQuerySortOrder</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK24UsergridImageContentType"></a>
- <a name="//apple_ref/swift/Enum/UsergridImageContentType" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK24UsergridImageContentType">UsergridImageContentType</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> image specific content types.</p>
-
- <a href="Enums/UsergridImageContentType.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridImageContentType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK17UsergridDirection"></a>
- <a name="//apple_ref/swift/Enum/UsergridDirection" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK17UsergridDirection">UsergridDirection</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>An enumeration that is used when getting connections to entity objects. Used to determine which the direction of the connection is wanted.</p>
-
- <a href="Enums/UsergridDirection.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridDirection</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK18UsergridHttpMethod"></a>
- <a name="//apple_ref/swift/Enum/UsergridHttpMethod" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK18UsergridHttpMethod">UsergridHttpMethod</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>An enumeration for defining the HTTP methods used by Usergrid.</p>
-
- <a href="Enums/UsergridHttpMethod.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridHttpMethod</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </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/Enums/UsergridAuthFallback.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridAuthFallback.html b/sdks/swift/docs/Enums/UsergridAuthFallback.html
deleted file mode 100644
index 13d19bc..0000000
--- a/sdks/swift/docs/Enums/UsergridAuthFallback.html
+++ /dev/null
@@ -1,248 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuthFallback Enum 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/Enum/UsergridAuthFallback" class="dashAnchor"></a>
- <a title="UsergridAuthFallback Enum 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" />
- UsergridAuthFallback Enum 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>UsergridAuthFallback</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridAuthFallback</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p>An enumeration that is used to determine what the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> will fallback to depending on certain authorization conditions.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK20UsergridAuthFallback4NoneFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/None" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK20UsergridAuthFallback4NoneFMS0_S0_">None</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>If a non-expired user auth token exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p>
-
-<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.</p>
-
-<p>If a non-expired user auth token does not exist, all API calls will be made unauthenticated.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">None</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK20UsergridAuthFallback3AppFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/App" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK20UsergridAuthFallback3AppFMS0_S0_">App</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>If a non-expired user auth token exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p>
-
-<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authFallback=.None).</p>
-
-<p>If a non-expired user auth does not exist, all API calls will be made using stored app auth.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">App</span></code></pre>
-
- </div>
- </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 \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/Enums/UsergridAuthMode.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridAuthMode.html b/sdks/swift/docs/Enums/UsergridAuthMode.html
deleted file mode 100644
index 7ed672a..0000000
--- a/sdks/swift/docs/Enums/UsergridAuthMode.html
+++ /dev/null
@@ -1,283 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuthMode Enum 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/Enum/UsergridAuthMode" class="dashAnchor"></a>
- <a title="UsergridAuthMode Enum 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" />
- UsergridAuthMode Enum 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>UsergridAuthMode</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridAuthMode</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p>An enumeration that is used to determine what the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> will use for authorization.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK16UsergridAuthMode4NoneFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/None" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK16UsergridAuthMode4NoneFMS0_S0_">None</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">None</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK16UsergridAuthMode4UserFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/User" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK16UsergridAuthMode4UserFMS0_S0_">User</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>If a non-expired <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p>
-
-<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">User</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK16UsergridAuthMode3AppFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/App" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK16UsergridAuthMode3AppFMS0_S0_">App</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>If a non-expired <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_">UsergridClient.appAuth</a></code>, this token is used to authenticate all API calls.</p>
-
-<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">App</span></code></pre>
-
- </div>
- </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>
[05/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/docSet.dsidx
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/docSet.dsidx b/sdks/swift/docs/docsets/.docset/Contents/Resources/docSet.dsidx
deleted file mode 100644
index 15754e6..0000000
Binary files a/sdks/swift/docs/docsets/.docset/Contents/Resources/docSet.dsidx and /dev/null differ
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.tgz
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.tgz b/sdks/swift/docs/docsets/.tgz
deleted file mode 100644
index 453a706..0000000
Binary files a/sdks/swift/docs/docsets/.tgz and /dev/null differ
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Info.plist
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Info.plist b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Info.plist
deleted file mode 100644
index 66e4f3b..0000000
--- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Info.plist
+++ /dev/null
@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
- <dict>
- <key>CFBundleIdentifier</key>
- <string>com.jazzy.usergridsdk</string>
- <key>CFBundleName</key>
- <string>UsergridSDK</string>
- <key>DocSetPlatformFamily</key>
- <string>jazzy</string>
- <key>isDashDocset</key>
- <true/>
- <key>dashIndexFilePath</key>
- <string>index.html</string>
- <key>isJavaScriptEnabled</key>
- <true/>
- <key>DashDocSetFamily</key>
- <string>dashtoc</string>
- </dict>
-</plist>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes.html
deleted file mode 100644
index c867dcf..0000000
--- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes.html
+++ /dev/null
@@ -1,694 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Classes 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 title="Classes 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" />
- Classes 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>Classes</h1>
- <p>The following classes are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK21UsergridResponseError"></a>
- <a name="//apple_ref/swift/Class/UsergridResponseError" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK21UsergridResponseError">UsergridResponseError</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A standard error object that contains details about a request failure.</p>
-
- <a href="Classes/UsergridResponseError.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridResponseError</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK15UsergridRequest"></a>
- <a name="//apple_ref/swift/Class/UsergridRequest" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK15UsergridRequest">UsergridRequest</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The UsergridRequest class incapsulates the properties that all requests made by the SDK have in common. </p>
-
-<p>This class is also functions to create <code>NSURLRequest</code> objects based on the properties of the class.</p>
-
- <a href="Classes/UsergridRequest.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridRequest</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK26UsergridAssetUploadRequest"></a>
- <a name="//apple_ref/swift/Class/UsergridAssetUploadRequest" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK26UsergridAssetUploadRequest">UsergridAssetUploadRequest</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="Classes/UsergridRequest.html">UsergridRequest</a></code> sub class which is used for uploading assets.</p>
-
- <a href="Classes/UsergridAssetUploadRequest.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridAssetUploadRequest</span><span class="p">:</span> <span class="kt">UsergridRequest</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK20UsergridClientConfig"></a>
- <a name="//apple_ref/swift/Class/UsergridClientConfig" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK20UsergridClientConfig">UsergridClientConfig</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridClientConfig</code> is used when initializing <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> objects.</p>
-
-<p>The <code>UsergridClientConfig</code> is meant for further customization of <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> objects when needed.</p>
-
- <a href="Classes/UsergridClientConfig.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridClientConfig</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK12UsergridAuth"></a>
- <a name="//apple_ref/swift/Class/UsergridAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK12UsergridAuth">UsergridAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>UsergridAuth</code> class functions to create and store authentication information used by Usergrid.</p>
-
-<p>The <code>UsergridAuth</code> sub classes, <code><a href="Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> and <code><a href="Classes/UsergridUserAuth.html">UsergridUserAuth</a></code>, provide different ways for authentication to be used in creating requests for access tokens through the SDK.</p>
-
- <a href="Classes/UsergridAuth.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK16UsergridUserAuth"></a>
- <a name="//apple_ref/swift/Class/UsergridUserAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK16UsergridUserAuth">UsergridUserAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="Classes/UsergridAuth.html">UsergridAuth</a></code> subclass used for user level authorization.</p>
-
- <a href="Classes/UsergridUserAuth.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridUserAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK15UsergridAppAuth"></a>
- <a name="//apple_ref/swift/Class/UsergridAppAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK15UsergridAppAuth">UsergridAppAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="Classes/UsergridAuth.html">UsergridAuth</a></code> subclass used for application level authorization.</p>
-
- <a href="Classes/UsergridAppAuth.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridAppAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK20UsergridFileMetaData"></a>
- <a name="//apple_ref/swift/Class/UsergridFileMetaData" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK20UsergridFileMetaData">UsergridFileMetaData</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridFileMetaData</code> is a helper class for dealing with reading <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> file meta data.</p>
-
- <a href="Classes/UsergridFileMetaData.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridFileMetaData</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span><span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK14UsergridDevice"></a>
- <a name="//apple_ref/swift/Class/UsergridDevice" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK14UsergridDevice">UsergridDevice</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridDevice</code> is an <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> subclass that encapsulates information about the current device as well as stores information about push tokens and Usergrid notifiers.</p>
-
-<p>To apply push tokens for Usergrid notifiers use the <code>UsergridClient.applyPushToken</code> method.</p>
-
- <a href="Classes/UsergridDevice.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridDevice</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK13UsergridQuery"></a>
- <a name="//apple_ref/swift/Class/UsergridQuery" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK13UsergridQuery">UsergridQuery</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridQuery</code> is builder class used to construct filtered requests to Usergrid.</p>
-
-<p><code>UsergridQuery</code> objects are then passed to <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> or <code><a href="Classes/Usergrid.html">Usergrid</a></code> methods which support <code>UsergridQuery</code> as a parameter are .GET(), .PUT(), and .DELETE().</p>
-
- <a href="Classes/UsergridQuery.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridQuery</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span><span class="kt">NSCopying</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK14UsergridEntity"></a>
- <a name="//apple_ref/swift/Class/UsergridEntity" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK14UsergridEntity">UsergridEntity</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridEntity</code> is the base class that contains a single Usergrid entity. </p>
-
-<p><code>UsergridEntity</code> maintains a set of accessor properties for standard Usergrid schema properties (e.g. name, uuid), and supports helper methods for accessing any custom properties that might exist.</p>
-
- <a href="Classes/UsergridEntity.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridEntity</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK12UsergridUser"></a>
- <a name="//apple_ref/swift/Class/UsergridUser" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK12UsergridUser">UsergridUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridUser</code> is a special subclass of <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> that supports functions and properties unique to users.</p>
-
- <a href="Classes/UsergridUser.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridUser</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK8Usergrid"></a>
- <a name="//apple_ref/swift/Class/Usergrid" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK8Usergrid">Usergrid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>Usergrid</code> class acts as a static shared instance manager for the <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> class.</p>
-
-<p>The methods and variables in this class are all static and therefore you will never need or want to initialize an instance of the <code>Usergrid</code> class.</p>
-
-<p>Use of this class depends on initialization of the shared instance of the <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> object. Because of this, before using any of the static methods
-provided you will need to call one of the shared instance initialization methods. Failure to do so will result in failure from all methods.</p>
-
- <a href="Classes/Usergrid.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">Usergrid</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK16UsergridResponse"></a>
- <a name="//apple_ref/swift/Class/UsergridResponse" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK16UsergridResponse">UsergridResponse</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridResponse</code> is the core class that handles both successful and unsuccessful HTTP responses from Usergrid. </p>
-
-<p>If a request is successful, any entities returned in the response will be automatically parsed into <code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> objects and pushed to the <code>entities</code> property.</p>
-
-<p>If a request fails, the <code>UsergridResponseError.error</code> property will contain information about the problem encountered.</p>
-
- <a href="Classes/UsergridResponse.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridResponse</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK13UsergridAsset"></a>
- <a name="//apple_ref/swift/Class/UsergridAsset" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK13UsergridAsset">UsergridAsset</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
-
- <a href="Classes/UsergridAsset.html" class="slightly-smaller">See more</a>
- </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">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>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:C11UsergridSDK14UsergridClient"></a>
- <a name="//apple_ref/swift/Class/UsergridClient" class="dashAnchor"></a>
- <a class="token" href="#/s:C11UsergridSDK14UsergridClient">UsergridClient</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>UsergridClient</code> class is the base handler for making client connections to and managing relationships with Usergrid’s API.</p>
-
- <a href="Classes/UsergridClient.html" class="slightly-smaller">See more</a>
- </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">class</span> <span class="kt">UsergridClient</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </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 \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>
[51/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
Moving Swift SDK to https://github.com/apache/usergrid-swift.
Project: http://git-wip-us.apache.org/repos/asf/usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/usergrid/commit/ae39eca6
Tree: http://git-wip-us.apache.org/repos/asf/usergrid/tree/ae39eca6
Diff: http://git-wip-us.apache.org/repos/asf/usergrid/diff/ae39eca6
Branch: refs/heads/master
Commit: ae39eca6a764caffbfac1da47958cd3384c130a2
Parents: d2061dc
Author: Michael Russo <mr...@apigee.com>
Authored: Thu Sep 1 16:51:24 2016 -0700
Committer: Michael Russo <mr...@apigee.com>
Committed: Thu Sep 1 16:51:24 2016 -0700
----------------------------------------------------------------------
sdks/swift/.gitignore | 25 -
sdks/swift/LICENSE.txt | 19 -
sdks/swift/Package.swift | 30 -
sdks/swift/README.md | 804 +---
.../ActivityFeed.xcodeproj/project.pbxproj | 827 ----
.../contents.xcworkspacedata | 7 -
.../contents.xcworkspacedata | 7 -
.../xcshareddata/ActivityFeed.xcscmblueprint | 30 -
sdks/swift/Samples/ActivityFeed/Podfile | 8 -
sdks/swift/Samples/ActivityFeed/Readme.md | 29 -
.../ActivityFeed/Source/ActivityEntity.swift | 60 -
.../ActivityFeed/Source/AppDelegate.swift | 65 -
.../AppIcon.appiconset/Contents.json | 38 -
.../Source/Assets.xcassets/Contents.json | 6 -
.../UsergridGuy.imageset/Contents.json | 21 -
.../UsergridGuy.imageset/UsergridGuy.png | Bin 6230 -> 0 bytes
.../Source/Base.lproj/LaunchScreen.storyboard | 27 -
.../Source/Base.lproj/Main.storyboard | 371 --
.../Source/FollowViewController.swift | 50 -
.../ActivityFeed/Source/FormTextField.swift | 71 -
.../Samples/ActivityFeed/Source/Info.plist | 43 -
.../Source/LoginViewController.swift | 77 -
.../Source/MessageTableViewCell.swift | 101 -
.../ActivityFeed/Source/MessageTextView.swift | 39 -
.../Source/MessageViewController.swift | 224 -
.../Source/RegisterViewController.swift | 62 -
.../ActivityFeed/Source/UsergridManager.swift | 78 -
.../Source/ViewControllerExtensions.swift | 36 -
.../Assets.xcassets/README__ignoredByTemplate__ | 1 -
.../ExtensionDelegate.swift | 45 -
.../WatchSample Extension/Info.plist | 45 -
.../InterfaceController.swift | 81 -
.../AppIcon.appiconset/Contents.json | 55 -
.../WatchSample/Base.lproj/Interface.storyboard | 46 -
.../Samples/ActivityFeed/WatchSample/Info.plist | 35 -
.../Samples/Push/Push.xcodeproj/project.pbxproj | 473 ---
.../contents.xcworkspacedata | 7 -
.../Push.xcworkspace/contents.xcworkspacedata | 7 -
sdks/swift/Samples/Push/Readme.md | 21 -
.../swift/Samples/Push/Source/AppDelegate.swift | 53 -
.../AppIcon.appiconset/Contents.json | 38 -
.../Push/Source/Assets.xcassets/Contents.json | 6 -
.../UsergridGuy.imageset/Contents.json | 21 -
.../UsergridGuy.imageset/UsergridGuy.png | Bin 6230 -> 0 bytes
.../Source/Base.lproj/LaunchScreen.storyboard | 27 -
.../Push/Source/Base.lproj/Main.storyboard | 75 -
sdks/swift/Samples/Push/Source/Info.plist | 38 -
.../Samples/Push/Source/UsergridManager.swift | 72 -
.../Samples/Push/Source/ViewController.swift | 39 -
sdks/swift/Samples/Readme.md | 27 -
sdks/swift/Source/Info.plist | 26 -
sdks/swift/Source/Usergrid.swift | 637 ---
sdks/swift/Source/UsergridAsset.swift | 198 -
.../Source/UsergridAssetRequestWrapper.swift | 48 -
sdks/swift/Source/UsergridAuth.swift | 276 --
sdks/swift/Source/UsergridClient.swift | 931 -----
sdks/swift/Source/UsergridClientConfig.swift | 149 -
sdks/swift/Source/UsergridDevice.swift | 213 -
sdks/swift/Source/UsergridEntity.swift | 635 ---
sdks/swift/Source/UsergridEnums.swift | 417 --
sdks/swift/Source/UsergridExtensions.swift | 112 -
sdks/swift/Source/UsergridFileMetaData.swift | 114 -
sdks/swift/Source/UsergridKeychainHelpers.swift | 196 -
sdks/swift/Source/UsergridQuery.swift | 591 ---
sdks/swift/Source/UsergridRequest.swift | 245 --
sdks/swift/Source/UsergridRequestManager.swift | 176 -
sdks/swift/Source/UsergridResponse.swift | 203 -
sdks/swift/Source/UsergridResponseError.swift | 90 -
sdks/swift/Source/UsergridSDK.h | 37 -
sdks/swift/Source/UsergridSessionDelegate.swift | 90 -
sdks/swift/Source/UsergridUser.swift | 523 ---
sdks/swift/Tests/ASSET_Tests.swift | 280 --
sdks/swift/Tests/AUTH_Tests.swift | 132 -
sdks/swift/Tests/CONNECTION_Tests.swift | 105 -
sdks/swift/Tests/ClientCreationTests.swift | 74 -
sdks/swift/Tests/Entity_Tests.swift | 173 -
sdks/swift/Tests/GET_Tests.swift | 113 -
sdks/swift/Tests/Info.plist | 24 -
sdks/swift/Tests/PUT_Tests.swift | 158 -
sdks/swift/Tests/TestAssets/UsergridGuy.jpg | Bin 12981 -> 0 bytes
sdks/swift/Tests/TestAssets/logo_apigee.png | Bin 10696 -> 0 bytes
sdks/swift/Tests/TestAssets/test.png | Bin 1417937 -> 0 bytes
sdks/swift/Tests/User_Tests.swift | 399 --
.../swift/UsergridSDK.xcodeproj/project.pbxproj | 1179 ------
.../contents.xcworkspacedata | 7 -
.../xcshareddata/WorkspaceSettings.xcsettings | 8 -
.../xcschemes/UsergridSDK OSX.xcscheme | 100 -
.../xcschemes/UsergridSDK iOS.xcscheme | 100 -
.../xcschemes/UsergridSDK tvOS.xcscheme | 114 -
.../xcschemes/UsergridSDK watchOS.xcscheme | 80 -
.../xcschemes/UsergridSDK_OSX_Tests.xcscheme | 56 -
.../xcschemes/UsergridSDK_TVOS_Tests.xcscheme | 56 -
.../xcschemes/UsergridSDK_iOS_Tests.xcscheme | 57 -
sdks/swift/docs/Classes.html | 702 ----
sdks/swift/docs/Classes/Usergrid.html | 3798 -----------------
sdks/swift/docs/Classes/UsergridAppAuth.html | 410 --
sdks/swift/docs/Classes/UsergridAsset.html | 702 ----
.../Classes/UsergridAssetUploadRequest.html | 356 --
sdks/swift/docs/Classes/UsergridAuth.html | 558 ---
sdks/swift/docs/Classes/UsergridClient.html | 3873 ------------------
.../docs/Classes/UsergridClientConfig.html | 744 ----
sdks/swift/docs/Classes/UsergridDevice.html | 763 ----
sdks/swift/docs/Classes/UsergridEntity.html | 2683 ------------
.../docs/Classes/UsergridFileMetaData.html | 532 ---
sdks/swift/docs/Classes/UsergridQuery.html | 2278 ----------
.../UsergridQuery/UsergridQueryOperator.html | 272 --
.../UsergridQuery/UsergridQuerySortOrder.html | 203 -
sdks/swift/docs/Classes/UsergridRequest.html | 619 ---
sdks/swift/docs/Classes/UsergridResponse.html | 969 -----
.../docs/Classes/UsergridResponseError.html | 473 ---
sdks/swift/docs/Classes/UsergridUser.html | 2434 -----------
.../UsergridUser/UsergridUserProperties.html | 346 --
sdks/swift/docs/Classes/UsergridUserAuth.html | 410 --
sdks/swift/docs/Enums.html | 435 --
sdks/swift/docs/Enums/UsergridAuthFallback.html | 248 --
sdks/swift/docs/Enums/UsergridAuthMode.html | 283 --
.../docs/Enums/UsergridDeviceProperties.html | 369 --
sdks/swift/docs/Enums/UsergridDirection.html | 286 --
.../docs/Enums/UsergridEntityProperties.html | 514 ---
sdks/swift/docs/Enums/UsergridHttpMethod.html | 341 --
.../docs/Enums/UsergridImageContentType.html | 286 --
.../swift/docs/Enums/UsergridQueryOperator.html | 431 --
.../docs/Enums/UsergridQuerySortOrder.html | 338 --
.../docs/Enums/UsergridUserProperties.html | 524 ---
sdks/swift/docs/Extensions.html | 203 -
sdks/swift/docs/Extensions/NSDate.html | 448 --
sdks/swift/docs/Extensions/UsergridAsset.html | 184 -
sdks/swift/docs/Extensions/UsergridAuth.html | 260 --
sdks/swift/docs/Extensions/UsergridClient.html | 1962 ---------
sdks/swift/docs/Global Variables.html | 210 -
sdks/swift/docs/Protocols.html | 146 -
sdks/swift/docs/Protocols/UsergridAuth.html | 260 --
sdks/swift/docs/Typealiases.html | 411 --
sdks/swift/docs/css/highlight.css | 200 -
sdks/swift/docs/css/jazzy.css | 331 --
.../docs/docsets/.docset/Contents/Info.plist | 20 -
.../Contents/Resources/Documents/Classes.html | 702 ----
.../Resources/Documents/Classes/Usergrid.html | 3798 -----------------
.../Documents/Classes/UsergridAppAuth.html | 410 --
.../Documents/Classes/UsergridAsset.html | 702 ----
.../Classes/UsergridAssetUploadRequest.html | 356 --
.../Documents/Classes/UsergridAuth.html | 558 ---
.../Documents/Classes/UsergridClient.html | 3873 ------------------
.../Documents/Classes/UsergridClientConfig.html | 744 ----
.../Documents/Classes/UsergridDevice.html | 763 ----
.../Documents/Classes/UsergridEntity.html | 2683 ------------
.../Documents/Classes/UsergridFileMetaData.html | 532 ---
.../Documents/Classes/UsergridQuery.html | 2278 ----------
.../UsergridQuery/UsergridQueryOperator.html | 272 --
.../UsergridQuery/UsergridQuerySortOrder.html | 203 -
.../Documents/Classes/UsergridRequest.html | 619 ---
.../Documents/Classes/UsergridResponse.html | 969 -----
.../Classes/UsergridResponseError.html | 473 ---
.../Documents/Classes/UsergridUser.html | 2434 -----------
.../UsergridUser/UsergridUserProperties.html | 346 --
.../Documents/Classes/UsergridUserAuth.html | 410 --
.../Contents/Resources/Documents/Enums.html | 435 --
.../Documents/Enums/UsergridAuthFallback.html | 248 --
.../Documents/Enums/UsergridAuthMode.html | 283 --
.../Enums/UsergridDeviceProperties.html | 369 --
.../Documents/Enums/UsergridDirection.html | 286 --
.../Enums/UsergridEntityProperties.html | 514 ---
.../Documents/Enums/UsergridHttpMethod.html | 341 --
.../Enums/UsergridImageContentType.html | 286 --
.../Documents/Enums/UsergridQueryOperator.html | 431 --
.../Documents/Enums/UsergridQuerySortOrder.html | 338 --
.../Documents/Enums/UsergridUserProperties.html | 524 ---
.../Resources/Documents/Extensions.html | 203 -
.../Resources/Documents/Extensions/NSDate.html | 448 --
.../Documents/Extensions/UsergridAsset.html | 184 -
.../Documents/Extensions/UsergridAuth.html | 260 --
.../Documents/Extensions/UsergridClient.html | 1962 ---------
.../Resources/Documents/Global Variables.html | 210 -
.../Contents/Resources/Documents/Protocols.html | 146 -
.../Documents/Protocols/UsergridAuth.html | 260 --
.../Resources/Documents/Typealiases.html | 411 --
.../Resources/Documents/css/highlight.css | 200 -
.../Contents/Resources/Documents/css/jazzy.css | 331 --
.../Contents/Resources/Documents/img/carat.png | Bin 274 -> 0 bytes
.../Contents/Resources/Documents/img/dash.png | Bin 1338 -> 0 bytes
.../Contents/Resources/Documents/img/gh.png | Bin 1571 -> 0 bytes
.../Contents/Resources/Documents/index.html | 927 -----
.../Contents/Resources/Documents/js/jazzy.js | 40 -
.../Resources/Documents/js/jquery.min.js | 4 -
.../Resources/Documents/undocumented.txt | 0
.../.docset/Contents/Resources/docSet.dsidx | Bin 147456 -> 0 bytes
sdks/swift/docs/docsets/.tgz | Bin 148251 -> 0 bytes
.../UsergridSDK.docset/Contents/Info.plist | 20 -
.../Contents/Resources/Documents/Classes.html | 694 ----
.../Resources/Documents/Classes/Usergrid.html | 3704 -----------------
.../Documents/Classes/UsergridAppAuth.html | 402 --
.../Documents/Classes/UsergridAsset.html | 694 ----
.../Classes/UsergridAssetUploadRequest.html | 348 --
.../Documents/Classes/UsergridAuth.html | 550 ---
.../Documents/Classes/UsergridClient.html | 3800 -----------------
.../Documents/Classes/UsergridClientConfig.html | 736 ----
.../Documents/Classes/UsergridDevice.html | 644 ---
.../Documents/Classes/UsergridEntity.html | 2612 ------------
.../Documents/Classes/UsergridFileMetaData.html | 524 ---
.../Documents/Classes/UsergridQuery.html | 2270 ----------
.../UsergridQuery/UsergridQueryOperator.html | 272 --
.../UsergridQuery/UsergridQuerySortOrder.html | 203 -
.../Documents/Classes/UsergridRequest.html | 611 ---
.../Documents/Classes/UsergridResponse.html | 961 -----
.../Classes/UsergridResponseError.html | 465 ---
.../Documents/Classes/UsergridUser.html | 2319 -----------
.../UsergridUser/UsergridUserProperties.html | 346 --
.../Documents/Classes/UsergridUserAuth.html | 402 --
.../Contents/Resources/Documents/Enums.html | 427 --
.../Documents/Enums/UsergridAuthFallback.html | 248 --
.../Enums/UsergridDeviceProperties.html | 361 --
.../Documents/Enums/UsergridDirection.html | 278 --
.../Enums/UsergridEntityProperties.html | 506 ---
.../Documents/Enums/UsergridHttpMethod.html | 333 --
.../Enums/UsergridImageContentType.html | 278 --
.../Documents/Enums/UsergridQueryOperator.html | 423 --
.../Documents/Enums/UsergridQuerySortOrder.html | 330 --
.../Documents/Enums/UsergridUserProperties.html | 516 ---
.../Resources/Documents/Extensions.html | 175 -
.../Documents/Extensions/UsergridAsset.html | 184 -
.../Documents/Extensions/UsergridAuth.html | 260 --
.../Documents/Extensions/UsergridClient.html | 1962 ---------
.../Resources/Documents/Global Variables.html | 202 -
.../Contents/Resources/Documents/Protocols.html | 146 -
.../Documents/Protocols/UsergridAuth.html | 260 --
.../Resources/Documents/Typealiases.html | 403 --
.../Resources/Documents/css/highlight.css | 200 -
.../Contents/Resources/Documents/css/jazzy.css | 331 --
.../Contents/Resources/Documents/img/carat.png | Bin 274 -> 0 bytes
.../Contents/Resources/Documents/img/dash.png | Bin 1338 -> 0 bytes
.../Contents/Resources/Documents/img/gh.png | Bin 1571 -> 0 bytes
.../Contents/Resources/Documents/index.html | 919 -----
.../Contents/Resources/Documents/js/jazzy.js | 40 -
.../Resources/Documents/js/jquery.min.js | 4 -
.../Resources/Documents/undocumented.txt | 0
.../Contents/Resources/docSet.dsidx | Bin 151552 -> 0 bytes
sdks/swift/docs/docsets/UsergridSDK.tgz | Bin 145485 -> 0 bytes
sdks/swift/docs/img/carat.png | Bin 274 -> 0 bytes
sdks/swift/docs/img/dash.png | Bin 1338 -> 0 bytes
sdks/swift/docs/img/gh.png | Bin 1571 -> 0 bytes
sdks/swift/docs/index.html | 927 -----
sdks/swift/docs/js/jazzy.js | 40 -
sdks/swift/docs/js/jquery.min.js | 4 -
sdks/swift/docs/undocumented.txt | 0
244 files changed, 3 insertions(+), 110401 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/.gitignore
----------------------------------------------------------------------
diff --git a/sdks/swift/.gitignore b/sdks/swift/.gitignore
deleted file mode 100644
index 13b62f9..0000000
--- a/sdks/swift/.gitignore
+++ /dev/null
@@ -1,25 +0,0 @@
-# Mac OS X
-.DS_Store
-
-# Xcode
-build/
-*.pbxuser
-!default.pbxuser
-*.mode1v3
-!default.mode1v3
-*.mode2v3
-!default.mode2v3
-*.perspectivev3
-!default.perspectivev3
-xcuserdata
-*.xccheckout
-*.moved-aside
-DerivedData
-*.hmap
-*.ipa
-*.xcuserstate
-
-# Carthage
-Carthage/Build
-ActivityFeed/ActivityFeed.xcworkspace/xcuserdata/ApigeeCorporation.xcuserdatad/xcdebugger
-.build
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/LICENSE.txt
----------------------------------------------------------------------
diff --git a/sdks/swift/LICENSE.txt b/sdks/swift/LICENSE.txt
deleted file mode 100644
index 34193ba..0000000
--- a/sdks/swift/LICENSE.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Package.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Package.swift b/sdks/swift/Package.swift
deleted file mode 100644
index 73f2c87..0000000
--- a/sdks/swift/Package.swift
+++ /dev/null
@@ -1,30 +0,0 @@
-//
-// Package.swift
-//
-// Created by Robert Walsh on 10/23/15.
-//
-/*
-*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. The ASF licenses this file to You
-* under the Apache License, Version 2.0 (the "License"); you may not
-* use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License. For additional information regarding
-* copyright in this work, please see the NOTICE file in the top level
-* directory of this distribution.
-*
-*/
-
-import PackageDescription
-
-let package = Package(
- name: "UsergridSDK"
-)
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/README.md
----------------------------------------------------------------------
diff --git a/sdks/swift/README.md b/sdks/swift/README.md
index 14f93ea..29860f4 100644
--- a/sdks/swift/README.md
+++ b/sdks/swift/README.md
@@ -1,802 +1,4 @@
-# UsergridSDK
+# Usergrid Swift SDK
-[](http://cocoadocs.org/docsets/UsergridSDK)
-[](https://cocoapods.org/pods/UsergridSDK)
-
-Usergrid SDK written in Swift
-
-## Requirements
-
-> **While the Usergrid SDK is written in Swift, the functionality remains compatible with Objective-C.**
-
-> **Use `#import <UsergridSDK/UsergridSDK-Swift.h>` in your Objective-C files to enable the use of the SDK.**
-
-- iOS 8.0+ / Mac OS X 10.11+ / tvOS 9.1+ / watchOS 2.1+
-- Xcode 7.1+
-
-## Installation
-
-> **Embedded frameworks require a minimum deployment target of iOS 8 or OS X Mavericks (10.9).**
-
-### CocoaPods
-
-> **CocoaPods 0.39.0+ is required to build the UsergridSDK library.**
-
-To integrate the UsergridSDK into your Xcode project using CocoaPods, specify it in your `Podfile`:
-
-```ruby
-platform :ios, '8.0'
-use_frameworks!
-
-pod 'UsergridSDK'
-```
-
-Then, run the following command:
-
-```bash
-$ pod install
-```
-
-### Embedded Framework
-
-- Open up Terminal, `cd` into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
-
-```bash
-$ git init
-```
-
-- Add UsergridSDK as a git submodule by running the following command:
-
-```bash
-$ git submodule add https://github.com/apache/usergrid
-```
-
-- Open the `sdks/swift` folder, and drag the `UsergridSDK.xcodeproj` into the Project Navigator of your application's Xcode project.
-
-> It should appear nested underneath your application's blue project icon.
-
-- Select the `UsergridSDK.xcodeproj` in the Project Navigator and verify the deployment target matches that of your application target.
-- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
-- In the tab bar at the top of that window, open the "General" panel.
-- Click on the `+` button under the "Embedded Binaries" section.
-- Select the `UsergridSDK.framework`.
-
-> The `UsergridSDK.framework` is automatically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.
-
-## Documentation
-
-The documentation for this library is available [here](http://cocoadocs.org/docsets/UsergridSDK).
-
-## Initialization
-
-There are two different ways of initializing the Usergrid Swift SDK:
-
-1. The singleton pattern is both convenient and enables the developer to use a globally available and always-initialized instance of Usergrid.
-
-```swift
-Usergrid.initSharedInstance(orgId: "orgId", appId: "appId")
-```
-
-2. The Instance pattern enables the developer to manage instances of the Usergrid client independently and in an isolated fashion. The primary use-case for this is when an application connects to multiple Usergrid targets.
-
-```swift
-let client = UsergridClient(orgId: "orgId", appId: "appId")
-```
-
-_Note: Examples in this readme assume you are using the `Usergrid` shared instance. If you've implemented the instance pattern instead, simply replace `Usergrid` with your client instance variable._
-
-## Push Notifications
-
-_Note: You must have an Apple Developer account along with valid provisioning profiles set in order to receive push notifications._
-
-In order to utilize Usergrid push notifications, you must register the device with an Usergrid push notifier identifier.
-
-> For a more thorough example of recieving push notifications and sending push notifications (from the device) refer to the Push sample app located in the `/Samples` folder.
-
-The following code snippet shows how you would register for push notifications and apply the push token within the application delegate.
-
-```swift
-import UsergridSDK
-
-@UIApplicationMain class AppDelegate: UIResponder, UIApplicationDelegate {
-
- func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
-
- // Initialize the shared instance of Usergrid.
- Usergrid.initSharedInstance(orgId:"orgId", appId: "appId")
-
- // Register for APN
- application.registerUserNotificationSettings(UIUserNotificationSettings( forTypes: [.Alert, .Badge, .Sound], categories: nil))
- application.registerForRemoteNotifications()
-
- return true
- }
-
- func application(application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: NSData) {
- Usergrid.applyPushToken(deviceToken, notifierID: "notifierId") { response in
- // The push notification is now added to Usergrid for this device and this device will now be able to recieve notifications.
- }
- }
-}
-```
-
-## RESTful operations
-
-When making any RESTful call, a `type` parameter (or `path`) is always required. Whether you specify this as an argument or in an object as a parameter is up to you.
-
-### GET
-
-- To get entities in a collection:
-
-```swift
-Usergrid.GET("collection") { response in
- var entities: [UsergridEntity]? = response.entities
-}
-```
-
-- To get a specific entity in a collection by uuid or name:
-
-```swift
-Usergrid.GET("collection", uuidOrName:"<uuid-or-name>") { response in
- var entity: UsergridEntity? = response.entity?
-}
-```
-
-- To get specific entities in a collection by passing a `UsergridQuery` object:
-
-```swift
-var query = UsergridQuery("cats").gt("weight", value: 2.4)
- .contains("color", value:"bl*")
- .not()
- .eq("color", value:"blue")
- .or()
- .eq("color", value:"orange")
-
-// this will build out the following query:
-// select * where weight > 2.4 and color contains 'bl*' and not color = 'blue' or color = 'orange'
-
-Usergrid.GET(query) { response in
- var entities: [UsergridEntity]? = response.entities
-}
-```
-
-### POST and PUT
-
-POST and PUT requests both require a JSON body payload. You can pass either a Swift object or a `UsergridEntity` instance. While the former works in principle, best practise is to use a `UsergridEntity` wherever practical. When an entity has a uuid or name property and already exists on the server, use a PUT request to update it. If it does not, use POST to create it.
-
-- To create a new entity in a collection (**POST**):
-
-```swift
-var entity = UsergridEntity(type: "restaurant", propertyDict: ["restaurant": "Dino's Deep Dish","cuisine": "pizza"])
-
-Usergrid.POST(entity) { response in
- // entity should now have a uuid property and be created
-}
-
-// you can also POST an array of entities:
-
-var entities = [UsergridEntity(type: "restaurant", propertyDict:["restaurant": "Dino's Deep Dish","cuisine": "pizza"]),
- UsergridEntity(type: "restaurant", propertyDict:["restaurant": "Pizza da Napoli","cuisine": "pizza"])]
-
-Usergrid.POST(entities) { response in
- // response.entities should now contain now valid posted entities.
-}
-```
-
-- To update an entity in a collection (**PUT**):
-
-```swift
-var entity = UsergridEntity(type: "restaurant", propertyDict:["restaurant": "Dino's Deep Dish", "cuisine": "pizza"])
-
-Usergrid.POST(entity) { response in
- if let responseEntity = response.entity {
- responseEntity["owner"] = "Mia Carrara"
- Usergrid.PUT(responseEntity) { (response) -> Void in
- // entity now has the property 'owner'
- }
- }
-}
-
-// or update a set of entities by passing a UsergridQuery object
-
-var query = UsergridQuery("restaurants").eq("cuisine", value:"italian")
-
-Usergrid.PUT(query, jsonBody: ["keywords":["pasta"]]) { response in
-
- /* the first 10 entities matching this query criteria will be updated:
- e.g.:
- [
- {
- "type": "restaurant",
- "restaurant": "Il Tarazzo",
- "cuisine": "italian",
- "keywords": ["pasta"]
- },
- {
- "type": "restaurant",
- "restaurant": "Cono Sur Pizza & Pasta",
- "cuisine": "italian",
- "keywords": ["pasta"]
- }
- ]
- */
-}
-```
-
-### DELETE
-
-DELETE requests require either a specific entity or a `UsergridQuery` object to be passed as an argument.
-
-- To delete a specific entity in a collection by uuid or name:
-
-```swift
-Usergrid.DELETE("collection", uuidOrName: "<uuid-or-name>") { response in
- // if successful, entity will now be deleted
-})
-```
-
-- To specific entities in a collection to delete by passing a `UsergridQuery` object:
-
-```swift
-let query = UsergridQuery("cats").eq("color", value:"black")
- .or()
- .eq("color", value:"white")
-
-// this will build out the following query:
-// select * where color = 'black' or color = 'white'
-
-Usergrid.DELETE(query) { response in
- // the first 10 entities matching this query criteria will be deleted
-}
-```
-
-## Entity operations and convenience methods
-
-`UsergridEntity` has a number of helper/convenience methods to make working with entities more convenient.
-
-### reload()
-
-Reloads the entity from the server:
-
-```swift
-entity.reload() { response in
- // entity is now reloaded from the server
-}
-```
-
-### save()
-
-Saves (or creates) the entity on the server:
-
-
-```swift
-entity["aNewProperty"] = "A new value"
-entity.save() { response in
- // entity is now updated on the server
-}
-```
-
-### remove()
-
-Deletes the entity from the server:
-
-```swift
-entity.remove() { response in
- // entity is now deleted on the server and the local instance should be destroyed
-}
-```
-
-## Authentication, current user, and auth-fallback
-
-### appAuth and authenticateApp()
-
-`Usergrid` can use the app client ID and secret that were passed upon initialization and automatically retrieve an app-level token for these credentials.
-
-```swift
-Usergrid.setAppAuth("<client-id>", "<client-secret>")
-Usergrid.authenticateApp() { response in
- // Usergrid.appAuth is authenticated automatically when this call is successful
-}
-```
-
-### currentUser, userAuth, and authenticateUser()
-
-`Usergrid` has a special `currentUser` property.
-
-> The current user is stored within the keychain so app relaunches will persist the user's login and token information. To adjust this feature edit the `Usergrid.persistCurrentUserInKeychain` property upon initialization.
-
-By default, when calling `authenticateUser()`, `.currentUser` will be set to this user if the authentication flow is successful.
-
-```swift
-let userAuth = UsergridUserAuth(username: "<username>", password: "<password>")
-Usergrid.authenticateUser(userAuth) { auth, user, error in
- // Usergrid.currentUser is set to the authenticated user and the token is stored within that context
-}
-```
-
-If you want to utilize authenticateUser without setting as the current user, simply pass a `false` boolean value as the second parameter:
-
-```swift
-let userAuth = UsergridUserAuth(username: "<username>", password: "<password>")
-Usergrid.authenticateUser(userAuth,setAsCurrentUser: false) { auth, user, error in
- // user is authenticated but Usergrid.currentUser is not set.
-}
-```
-
-### authFallback
-
-Auth-fallback defines what the client should do when a user token is not present.
-
-By default, `Usergrid.authFallback` is set to `.None`, whereby when a token is *not* present, an API call will be performed unauthenticated.
-
-If instead `Usergrid.authFallback` is set to `.App`, the API call will instead be performed using client credentials, _if_ they're available (i.e. `authenticateApp()` was performed at some point).
-
-### usingAuth()
-
-At times it is desireable to have complete, granular control over the authentication context of an API call.
-
-To facilitate this, the passthrough function `.usingAuth()` allows you to pre-define the auth context of the next API call.
-
-```swift
-// assume Usergrid.authFallback = .None
-
-Usergrid.usingAuth(Usergrid.appAuth!).POST("roles/guest/permissions", jsonBody: ["permission" : "get,post,put,delete:/**"] ) { response in
- // here we've temporarily used the client credentials to modify permissions
- // subsequent calls will not use this auth context
-}
-```
-
-## User operations and convenience methods
-
-`UsergridUser` has a number of helper/convenience methods to make working with user entities more convenient. If you are _not_ utilizing the `Usergrid` shared instance, you must pass an instance of `UsergridClient` as the first argument to any of these helper methods.
-
-### create()
-
-Creating a new user:
-
-```swift
-let user = UsergridUser(username: "username", password: "password")
-user.create() { response in
- // user has now been created and should have a valid uuid
-}
-```
-
-### login()
-
-A simpler means of retrieving a user-level token:
-
-```swift
-user.login("username", password: "password") { auth, user, error in
- // user is now logged in
-}
-```
-
-### logout()
-
-Logs out the selected user. You can also use this convenience method on `Usergrid.currentUser`.
-
-```swift
-user.logout() { response in
- // user is now logged out
-}
-```
-
-### resetPassword()
-
-Resets the password for the selected user.
-
-```swift
-user.resetPassword("oldPassword", new: "newPassword") { error, didSucceed in
- // if it was done correctly, the new password will be changed
- // 'didSucceed' is a boolean value that indicates whether it was changed successfully
-}
-```
-
-### UsergridUser.CheckAvailable()
-
-This is a class (static) method that allows you to check whether a username or email address is available or not.
-
-```swift
-UsergridUser.checkAvailable("email", username: nil) { error, available in
- // 'available' == whether an email already exists for a user
-}
-
-UsergridUser.checkAvailable(nil, username: "username") { error, available in
- // 'available' == whether an username already exists for a user
-}
-
-UsergridUser.checkAvailable("email", username: "username") { error, available in
- // 'available' == whether an email or username already exist for a user
-}
-```
-
-## Querying and filtering data
-
-### UsergridQuery initialization
-
-The `UsergridQuery` class allows you to build out complex query filters using the Usergrid [query syntax](http://docs.apigee.com/app-services/content/querying-your-data).
-
-The first parameter of the `UsergridQuery` builder pattern should be the collection (or type) you intend to query. You can either pass this as an argument, or as the first builder object:
-
-```swift
-var query = UsergridQuery("cats")
-// or
-var query = UsergridQuery().collection("cats")
-```
-
-You then can layer on additional queries:
-
-```swift
-var query = UsergridQuery("cats").gt("weight", value: 2.4)
- .contains("color", value: "bl*")
- .not()
- .eq("color", value:"white")
- .or()
- .eq("color", value:"orange")
-```
-
-You can also adjust the number of results returned:
-
-```swift
-var query = UsergridQuery("cats").eq("color", value: "black")
- .limit(100)
-
-// returns a maximum of 100 entiteis
-```
-
-And sort the results:
-
-```swift
-var query = UsergridQuery("cats").eq("color", value: "black")
- .limit(100)
- .asc("name")
-
-// sorts by 'name', ascending
-```
-
-And you can do geo-location queries:
-
-```swift
-var query = UsergridQuery("devices").locationWithin(<distance>, latitude: <lat>, longitude: <long>)
-```
-
-### Using a query in a request
-
-Queries can be passed as parameters to GET, PUT, and DELETE requests:
-
-```swift
-Usergrid.GET("type", query: query) { response in
- // Gets entities of a given type matching the query.
-}
-
-Usergrid.PUT(query, jsonBody: ["aNewProperty":"A new value"]) { response in
- // Updates the entities matching the query with the new property.
-}
-
-Usergrid.DELETE(query) { response in
- // Deletes entities of a given type matching the query.
-}
-```
-### List of query builder objects
-
-`type("string")`
-
-> The collection name to query
-
-`collection("string")`
-
-> An alias for `type`
-
-`eq("key", value: "value")` or
-`equals("key", value: "value")` or
-`filter("key", value: "value")`
-
-> Equal to (e.g. `where color = 'black'`)
-
-`contains("key", value: "value")` or
-`containsString("key", value: "value")` or
-`containsWord("key", value: "value")`
-
-> Contains a string (e.g.` where color contains 'bl*'`)
-
-`gt("key", value: "value")` or
-`greaterThan("key", value: "value")`
-
-> Greater than (e.g. `where weight > 2.4`)
-
-`gte("key", value: "value")` or
-`greaterThanOrEqual("key", value: "value")`
-
-> Greater than or equal to (e.g. `where weight >= 2.4`)
-
-`lt("key", value: "value")` or `lessThan("key", value: "value")`
-
-> Less than (e.g. `where weight < 2.4`)
-
-`lte("key", value: "value")` or `lessThanOrEqual("key", value: "value")`
-
-> Less than or equal to (e.g. `where weight <= 2.4`)
-
-`not()`
-
-> Negates the next block in the builder pattern, e.g.:
-
-```swift
-var query = UsergridQuery("cats").not().eq("color", value: "black")
-// select * from cats where not color = 'black'
-```
-
-`and()`
-
-> Joins two queries by requiring both of them. `and` is also implied when joining two queries _without_ an operator. E.g.:
-
-```swift
-var query = UsergridQuery("cats").eq("color", value:"black").eq("fur", value:"longHair")
-// is identical to:
-var query = UsergridQuery("cats").eq("color", value:"black").and().eq("fur", value:"longHair")
-```
-
-`or()`
-
-> Joins two queries by requiring only one of them. `or` is never implied. e.g.:
-
-```swift
-var query = UsergridQuery("cats").eq("color",value: "black").or().eq("color", value: "white")
-```
-
-> When using `or()` and `and()` operators, `and()` joins will take precedence over `or()` joins. You can read more about query operators and precedence [here](http://docs.apigee.com/api-baas/content/supported-query-operators-data-types).
-
-`locationWithin(distanceInMeters, latitude: latitude, longitude: longitude)`
-
-> Returns entities which have a location within the specified radius. Arguments can be `float` or `int`.
-
-`asc("key")` or `ascending("key")`
-
-> Sorts the results by the specified property, ascending
-
-`desc("key")` or `descending("key")`
-
-> Sorts the results by the specified property, descending
-
-`sort("key", value: .Asc)`
-
-> Sorts the results by the specified property, in the specified `UsergridQuerySortOrder` (`.Asc` or `.Desc`).
-
-`limit(int)`
-
-> The maximum number of entities to return
-
-`cursor("string")`
-
-> A pagination cursor string
-
-`fromString("query string")`
-
-> A special builder property that allows you to input a pre-defined query string. All builder properties will be ignored when this property is defined. For example:
-
-```swift
-var query = UsergridQuery().fromString("select * where color = 'black' order by name asc")
-```
-
-## UsergridResponse object
-
-`UsergridResponse` is the core class that handles both successful and unsuccessful HTTP responses from Usergrid.
-
-If a request is successful, any entities returned in the response will be automatically parsed into `UsergridEntity` objects and pushed to the `entities` property.
-
-If a request fails, the `error` property will contain information about the problem encountered.
-
-### ok
-
-You can check `UsergridResponse.ok`, a `Bool` value, to see if the response was successful. Any status code `< 400` returns true.
-
-```swift
-Usergrid.GET("collection") { response in
- if response.ok {
- // woo!
- }
-}
-```
-
-### entity, entities, user, users, first, last
-
-Depending on the call you make, any entities returned in the response will be automatically parsed into `UsergridEntity` objects and pushed to the `entities` property. If you're querying the `users` collection, these will also be `UsergridUser` objects, a subclass of `UsergridEntity`.
-
-- `.first` returns the first entity in an array of entities; `.entity` is an alias to `.first`. If there are no entities, both of these will be undefined.
-
-- `.last` returns the last entity in an array of entities; if there is only one entity in the array, this will be the same as `.first` _and_ `.entity`, and will be undefined if there are no entities in the response.
-
-- `.entities` will either be an array of entities in the response, or an empty array.
-
-- `.user` is a special alias for `.entity` for when querying the `users` collection. Instead of being a `UsergridEntity`, it will be its subclass, `UsergridUser`.
-
-- `.users` is the same as `.user`, though behaves as `.entities` does by returning either an array of UsergridUser objects or an empty array.
-
-Examples:
-
-```swift
-Usergrid.GET("collection") { response in
- // you can access:
- // response.entities (the returned entities)
- // response.first (the first entity)
- // response.entity (same as response.first)
- // response.last (the last entity returned)
-}
-
-Usergrid.GET("collection", uuidOrName:"<uuid-or-name>") { response in
- // you can access:
- // response.entity (the returned entity)
- // response.entities (containing only the returned entity)
- // response.first (same as response.entity)
- // response.last (same as response.entity)
-}
-
-Usergrid.GET("users") { response in
- // you can access:
- // response.users (the returned users)
- // response.entities (same as response.users)
- // response.user (the first user)
- // response.entity (same as response.user)
- // response.first (same as response.user)
- // response.last (the last user)
-}
-
-Usergrid.GET("users", uuidOrName:"<uuid-or-name>") { response in
- // you can access;
- // response.users (containing only the one user)
- // response.entities (same as response.users)
- // response.user (the returned user)
- // response.entity (same as response.user)
- // response.first (same as response.user)
- // response.last (same as response.user)
-}
-```
-
-## Connections
-
-Connections can be managed using `Usergrid.connect()`, `Usergrid.disconnect()`, and `Usergrid.getConnections()`, or entity convenience methods of the same name.
-
-When retrieving connections via `Usergrid.getConnections()`, you can pass in a optional `UsergridQuery` object in order to filter the connectioned entities returned.
-
-### Connect
-
-Create a connection between two entities:
-
-```swift
-Usergrid.connect(entity1, relationship: "relationship", to: entity2) { response in
- // entity1 now has an outbound connection to entity2
-}
-```
-
-### Retrieve Connections
-
-Retrieve outbound connections:
-
-```swift
-Usergrid.getConnections(.Out, entity: entity1, relationship: "relationship", query: nil) { response in
- // entities is an array of entities that entity1 is connected to via 'relationship'
- // in this case, we'll see entity2 in the array
-}
-```
-
-Retrieve inbound connections:
-
-```swift
-Usergrid.getConnections(.In, entity: entity2, relationship: "relationship", query: nil) { response in
- // entities is an array of entities that connect to entity2 via 'relationship'
- // in this case, we'll see entity1 in the array
-}
-```
-
-### Disconnect
-
-Delete a connection between two entities:
-
-```swift
-Usergrid.disconnect(entity1, relationship: "relationship", from: entity2) { response in
- // entity1's outbound connection to entity2 has been destroyed
-}
-```
-
-## Assets
-
-Assets can be uploaded and downloaded either directly using `Usergrid.uploadAsset()` or `Usergrid.downloadAsset()`, or via `UsergridEntity` convenience methods with the same names. Before uploading an asset, you will need to initialize a `UsergridAsset` instance.
-
-### Initialization
-
-_Note: When initializing a `UsergridAsset` object specifying a file name is optional._
-
-- Using NSData:
-
-```swift
-let image = UIImage(contentsOfFile: "path/to/image")
-let data = UIImagePNGRepresentation(image)
-let asset = UsergridAsset(fileName:"<file-name-or-nil>", data: data!, contentType:"image/png")
-```
-
-- Using an UIImage object:
-
-```swift
-let image = UIImage(contentsOfFile: "path/to/image")
-let asset = UsergridAsset(fileName:"<file-name-or-nil>", image: image!, imageContentType: .Png)
-```
-
-- Using a file URL:
-
-```swift
-let fileUrl = NSURL(string: "local/path/to/file")
-if fileUrl.isFileReferenceURL() { // This must be a file reference url.
- let asset = UsergridAsset(fileName:"<file-name-or-nil>", fileUrl: fileUrl!, contentType:"<content-type>")
-}
-```
-
-### Uploading
-
-Upload an image and connect it to an entity:
-
-```swift
-let image = UIImage(contentsOfFile: "path/to/image")
-let asset = UsergridAsset(fileName:"<file-name-or-nil>", image: image!, imageContentType: .Png)!
-Usergrid.uploadAsset(entity,
- asset: asset,
- progress: { bytesFinished, bytesExpected in
- // Monitor the upload progress
- },
- completion: { asset, response in
- // The asset is now uploaded to Usergrid and entity.asset == asset
-})
-```
-
-### Downloading
-
-Download an image which is connected to an entity:
-
-```swift
-Usergrid.downloadAsset(entity,
- contentType: "<expected-content-type>",
- progress: { bytesFinished, bytesExpected in
- // Monitor the download progress
- },
- completion:{ asset, error in
- // The asset is now downloaded from Usergrid and entity.asset == asset
-})
-```
-
-## Custom UsergridEntity Subclasses
-
-Creating custom subclasses of the base `UsergridEntity` class (just like `UsergridUser` and `UsergridDevice`) is possible.
-
-> For a working example of creating a custom subclass refer to the ActivityFeed sample app located in the `/Samples` folder. The custom subclass there is named `ActivityEntity`.
-
-- To do so, subclass `UsergridEntity` and implement the required methods:
-
-```swift
-import UsergridSDK
-
-public class ActivityEntity: UsergridEntity {
-
- required public init(type: String, name: String?, propertyDict: [String : AnyObject]?) {
- super.init(type: type, name: name, propertyDict: propertyDict)
- }
-
- required public init?(coder aDecoder: NSCoder) {
- super.init(coder: aDecoder)
- }
-}
-```
-- You will also need to register the custom subclass:
-
-```swift
-Usergrid.initSharedInstance(orgId: "orgId", appId: "appId")
-UsergridEntity.mapCustomType("activity", toSubclass: ActivityEntity.self)
-```
-
-By registering your custom subclass, the `UsergridEntity` and `UsergridResponse` classes are able to generate instances of these classes based on the an entities `type`.
-
-In the above example, entities which have a `type` value of `activity` can now be cast as `ActivityEntity` objects. e.g.:
-
-```swift
-Usergrid.GET("activity") { response in
- var activityEntities: [ActivityEntity]? = response.entities as? [ActivityEntity]
-}
-```
+The Swift SDK code has been moved into its own repository and can be found
+at https://github.com/apache/usergrid-swift.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcodeproj/project.pbxproj
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcodeproj/project.pbxproj b/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcodeproj/project.pbxproj
deleted file mode 100644
index 215ca87..0000000
--- a/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcodeproj/project.pbxproj
+++ /dev/null
@@ -1,827 +0,0 @@
-// !$*UTF8*$!
-{
- archiveVersion = 1;
- classes = {
- };
- objectVersion = 46;
- objects = {
-
-/* Begin PBXBuildFile section */
- 634855401C726AE9005FE016 /* UsergridSDK.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 634855331C726AD3005FE016 /* UsergridSDK.framework */; };
- 634855411C726AE9005FE016 /* UsergridSDK.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 634855331C726AD3005FE016 /* UsergridSDK.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
- 634855451C726AF7005FE016 /* UsergridSDK.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 634855351C726AD3005FE016 /* UsergridSDK.framework */; };
- 634855461C726AF7005FE016 /* UsergridSDK.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 634855351C726AD3005FE016 /* UsergridSDK.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
- 6348D95F1C4EAC0B005C978C /* Interface.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 6348D95D1C4EAC0B005C978C /* Interface.storyboard */; };
- 6348D9611C4EAC0B005C978C /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 6348D9601C4EAC0B005C978C /* Assets.xcassets */; };
- 6348D9681C4EAC0B005C978C /* WatchSample Extension.appex in Embed App Extensions */ = {isa = PBXBuildFile; fileRef = 6348D9671C4EAC0B005C978C /* WatchSample Extension.appex */; settings = {ATTRIBUTES = (RemoveHeadersOnCopy, ); }; };
- 6348D96D1C4EAC0B005C978C /* InterfaceController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6348D96C1C4EAC0B005C978C /* InterfaceController.swift */; };
- 6348D96F1C4EAC0B005C978C /* ExtensionDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6348D96E1C4EAC0B005C978C /* ExtensionDelegate.swift */; };
- 6348D9711C4EAC0C005C978C /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 6348D9701C4EAC0C005C978C /* Assets.xcassets */; };
- 6348D9751C4EAC0C005C978C /* WatchSample.app in Embed Watch Content */ = {isa = PBXBuildFile; fileRef = 6348D95B1C4EAC0B005C978C /* WatchSample.app */; };
- 6348D9861C4EC1FD005C978C /* UsergridManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6348D9851C4EC1FD005C978C /* UsergridManager.swift */; };
- 6348D9871C4EC1FD005C978C /* UsergridManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6348D9851C4EC1FD005C978C /* UsergridManager.swift */; };
- 6355FEC51BFE4FC600E07170 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6355FEC41BFE4FC600E07170 /* AppDelegate.swift */; };
- 6355FEC71BFE4FC600E07170 /* ViewControllerExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6355FEC61BFE4FC600E07170 /* ViewControllerExtensions.swift */; };
- 6355FECA1BFE4FC600E07170 /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 6355FEC81BFE4FC600E07170 /* Main.storyboard */; };
- 6355FECC1BFE4FC600E07170 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 6355FECB1BFE4FC600E07170 /* Assets.xcassets */; };
- 6355FECF1BFE4FC600E07170 /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 6355FECD1BFE4FC600E07170 /* LaunchScreen.storyboard */; };
- 63C9E52A1C04F3B900C65F81 /* MessageTableViewCell.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63C9E5291C04F3B900C65F81 /* MessageTableViewCell.swift */; };
- 63C9E5311C05184900C65F81 /* MessageTextView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63C9E5301C05184900C65F81 /* MessageTextView.swift */; };
- 63CD143D1C505EC500C00076 /* ActivityEntity.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63CD143C1C505EC500C00076 /* ActivityEntity.swift */; };
- 63CD143E1C505EC500C00076 /* ActivityEntity.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63CD143C1C505EC500C00076 /* ActivityEntity.swift */; };
- 63E7DD741C518BAD00D84B12 /* LoginViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD731C518BAD00D84B12 /* LoginViewController.swift */; };
- 63E7DD761C518C9000D84B12 /* RegisterViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD751C518C9000D84B12 /* RegisterViewController.swift */; };
- 63E7DD781C518E0400D84B12 /* MessageViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD771C518E0400D84B12 /* MessageViewController.swift */; };
- 63E7DD7A1C518F1700D84B12 /* FollowViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD791C518F1700D84B12 /* FollowViewController.swift */; };
- 63E7DD7E1C518FDD00D84B12 /* FormTextField.swift in Sources */ = {isa = PBXBuildFile; fileRef = 63E7DD7D1C518FDD00D84B12 /* FormTextField.swift */; };
-/* End PBXBuildFile section */
-
-/* Begin PBXContainerItemProxy section */
- 634855321C726AD3005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 63AF0E881BBC38FB009D4196;
- remoteInfo = "UsergridSDK iOS";
- };
- 634855341C726AD3005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 639B4BEB1C3DD6CF005E26E7;
- remoteInfo = "UsergridSDK watchOS";
- };
- 634855361C726AD3005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 63EE610B1C406E1600AFC2CF;
- remoteInfo = "UsergridSDK tvOS";
- };
- 634855381C726AD3005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 631920451C48436500F99E86;
- remoteInfo = "UsergridSDK OSX";
- };
- 6348553A1C726AD3005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 6319204B1C49BC0700F99E86;
- remoteInfo = UsergridSDK_TVOS_Tests;
- };
- 6348553C1C726AD3005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 630A219F1C49BFFC008BE87F;
- remoteInfo = UsergridSDK_OSX_Tests;
- };
- 6348553E1C726AD3005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 630A21B81C49C473008BE87F;
- remoteInfo = UsergridSDK_iOS_Tests;
- };
- 634855421C726AE9005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 1;
- remoteGlobalIDString = 63AF0E871BBC38FB009D4196;
- remoteInfo = "UsergridSDK iOS";
- };
- 634855471C726AF7005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 1;
- remoteGlobalIDString = 639B4BEA1C3DD6CF005E26E7;
- remoteInfo = "UsergridSDK watchOS";
- };
- 6348D9691C4EAC0B005C978C /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 6355FEB91BFE4FC600E07170 /* Project object */;
- proxyType = 1;
- remoteGlobalIDString = 6348D9661C4EAC0B005C978C;
- remoteInfo = "WatchSample Extension";
- };
- 6348D9731C4EAC0C005C978C /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 6355FEB91BFE4FC600E07170 /* Project object */;
- proxyType = 1;
- remoteGlobalIDString = 6348D95A1C4EAC0B005C978C;
- remoteInfo = WatchSample;
- };
-/* End PBXContainerItemProxy section */
-
-/* Begin PBXCopyFilesBuildPhase section */
- 634855441C726AE9005FE016 /* Embed Frameworks */ = {
- isa = PBXCopyFilesBuildPhase;
- buildActionMask = 2147483647;
- dstPath = "";
- dstSubfolderSpec = 10;
- files = (
- 634855411C726AE9005FE016 /* UsergridSDK.framework in Embed Frameworks */,
- );
- name = "Embed Frameworks";
- runOnlyForDeploymentPostprocessing = 0;
- };
- 634855491C726AF8005FE016 /* Embed Frameworks */ = {
- isa = PBXCopyFilesBuildPhase;
- buildActionMask = 2147483647;
- dstPath = "";
- dstSubfolderSpec = 10;
- files = (
- 634855461C726AF7005FE016 /* UsergridSDK.framework in Embed Frameworks */,
- );
- name = "Embed Frameworks";
- runOnlyForDeploymentPostprocessing = 0;
- };
- 6348D97B1C4EAC0C005C978C /* Embed App Extensions */ = {
- isa = PBXCopyFilesBuildPhase;
- buildActionMask = 2147483647;
- dstPath = "";
- dstSubfolderSpec = 13;
- files = (
- 6348D9681C4EAC0B005C978C /* WatchSample Extension.appex in Embed App Extensions */,
- );
- name = "Embed App Extensions";
- runOnlyForDeploymentPostprocessing = 0;
- };
- 6348D97D1C4EAC0C005C978C /* Embed Watch Content */ = {
- isa = PBXCopyFilesBuildPhase;
- buildActionMask = 2147483647;
- dstPath = "$(CONTENTS_FOLDER_PATH)/Watch";
- dstSubfolderSpec = 16;
- files = (
- 6348D9751C4EAC0C005C978C /* WatchSample.app in Embed Watch Content */,
- );
- name = "Embed Watch Content";
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXCopyFilesBuildPhase section */
-
-/* Begin PBXFileReference section */
- 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = UsergridSDK.xcodeproj; path = ../../UsergridSDK.xcodeproj; sourceTree = "<group>"; };
- 6348D95B1C4EAC0B005C978C /* WatchSample.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = WatchSample.app; sourceTree = BUILT_PRODUCTS_DIR; };
- 6348D95E1C4EAC0B005C978C /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Interface.storyboard; sourceTree = "<group>"; };
- 6348D9601C4EAC0B005C978C /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
- 6348D9621C4EAC0B005C978C /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
- 6348D9671C4EAC0B005C978C /* WatchSample Extension.appex */ = {isa = PBXFileReference; explicitFileType = "wrapper.app-extension"; includeInIndex = 0; path = "WatchSample Extension.appex"; sourceTree = BUILT_PRODUCTS_DIR; };
- 6348D96C1C4EAC0B005C978C /* InterfaceController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InterfaceController.swift; sourceTree = "<group>"; };
- 6348D96E1C4EAC0B005C978C /* ExtensionDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExtensionDelegate.swift; sourceTree = "<group>"; };
- 6348D9701C4EAC0C005C978C /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
- 6348D9721C4EAC0C005C978C /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
- 6348D9851C4EC1FD005C978C /* UsergridManager.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridManager.swift; sourceTree = "<group>"; };
- 6355FEC11BFE4FC600E07170 /* ActivityFeed.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = ActivityFeed.app; sourceTree = BUILT_PRODUCTS_DIR; };
- 6355FEC41BFE4FC600E07170 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
- 6355FEC61BFE4FC600E07170 /* ViewControllerExtensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ViewControllerExtensions.swift; sourceTree = "<group>"; };
- 6355FEC91BFE4FC600E07170 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = "<group>"; };
- 6355FECB1BFE4FC600E07170 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
- 6355FECE1BFE4FC600E07170 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = "<group>"; };
- 6355FED01BFE4FC600E07170 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
- 63C9E5291C04F3B900C65F81 /* MessageTableViewCell.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MessageTableViewCell.swift; sourceTree = "<group>"; };
- 63C9E5301C05184900C65F81 /* MessageTextView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MessageTextView.swift; sourceTree = "<group>"; };
- 63CD143C1C505EC500C00076 /* ActivityEntity.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ActivityEntity.swift; sourceTree = "<group>"; };
- 63E7DD731C518BAD00D84B12 /* LoginViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LoginViewController.swift; sourceTree = "<group>"; };
- 63E7DD751C518C9000D84B12 /* RegisterViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = RegisterViewController.swift; sourceTree = "<group>"; };
- 63E7DD771C518E0400D84B12 /* MessageViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MessageViewController.swift; sourceTree = "<group>"; };
- 63E7DD791C518F1700D84B12 /* FollowViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FollowViewController.swift; sourceTree = "<group>"; };
- 63E7DD7D1C518FDD00D84B12 /* FormTextField.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FormTextField.swift; sourceTree = "<group>"; };
-/* End PBXFileReference section */
-
-/* Begin PBXFrameworksBuildPhase section */
- 6348D9641C4EAC0B005C978C /* Frameworks */ = {
- isa = PBXFrameworksBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 634855451C726AF7005FE016 /* UsergridSDK.framework in Frameworks */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 6355FEBE1BFE4FC600E07170 /* Frameworks */ = {
- isa = PBXFrameworksBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 634855401C726AE9005FE016 /* UsergridSDK.framework in Frameworks */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXFrameworksBuildPhase section */
-
-/* Begin PBXGroup section */
- 634855291C726AD3005FE016 /* Products */ = {
- isa = PBXGroup;
- children = (
- 634855331C726AD3005FE016 /* UsergridSDK.framework */,
- 634855351C726AD3005FE016 /* UsergridSDK.framework */,
- 634855371C726AD3005FE016 /* UsergridSDK.framework */,
- 634855391C726AD3005FE016 /* UsergridSDK.framework */,
- 6348553B1C726AD3005FE016 /* UsergridSDK_TVOS_Tests.xctest */,
- 6348553D1C726AD3005FE016 /* UsergridSDK_OSX_Tests.xctest */,
- 6348553F1C726AD3005FE016 /* UsergridSDK_iOS_Tests.xctest */,
- );
- name = Products;
- sourceTree = "<group>";
- };
- 6348D95C1C4EAC0B005C978C /* WatchSample */ = {
- isa = PBXGroup;
- children = (
- 6348D95D1C4EAC0B005C978C /* Interface.storyboard */,
- 6348D9601C4EAC0B005C978C /* Assets.xcassets */,
- 6348D9621C4EAC0B005C978C /* Info.plist */,
- );
- path = WatchSample;
- sourceTree = "<group>";
- };
- 6348D96B1C4EAC0B005C978C /* WatchSample Extension */ = {
- isa = PBXGroup;
- children = (
- 6348D96C1C4EAC0B005C978C /* InterfaceController.swift */,
- 6348D96E1C4EAC0B005C978C /* ExtensionDelegate.swift */,
- 6348D9701C4EAC0C005C978C /* Assets.xcassets */,
- 6348D9721C4EAC0C005C978C /* Info.plist */,
- );
- path = "WatchSample Extension";
- sourceTree = "<group>";
- };
- 6355FEB81BFE4FC600E07170 = {
- isa = PBXGroup;
- children = (
- 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */,
- 6355FEC31BFE4FC600E07170 /* Source */,
- 6348D95C1C4EAC0B005C978C /* WatchSample */,
- 6348D96B1C4EAC0B005C978C /* WatchSample Extension */,
- 6355FEC21BFE4FC600E07170 /* Products */,
- );
- sourceTree = "<group>";
- };
- 6355FEC21BFE4FC600E07170 /* Products */ = {
- isa = PBXGroup;
- children = (
- 6355FEC11BFE4FC600E07170 /* ActivityFeed.app */,
- 6348D95B1C4EAC0B005C978C /* WatchSample.app */,
- 6348D9671C4EAC0B005C978C /* WatchSample Extension.appex */,
- );
- name = Products;
- sourceTree = "<group>";
- };
- 6355FEC31BFE4FC600E07170 /* Source */ = {
- isa = PBXGroup;
- children = (
- 6355FEC41BFE4FC600E07170 /* AppDelegate.swift */,
- 6348D9851C4EC1FD005C978C /* UsergridManager.swift */,
- 63CD143C1C505EC500C00076 /* ActivityEntity.swift */,
- 63E7DD7B1C518F9600D84B12 /* View Controllers */,
- 63E7DD7C1C518FC300D84B12 /* Custom Views */,
- 63E7DD801C51903A00D84B12 /* Storyboards */,
- 63E7DD7F1C51902F00D84B12 /* Supporting Files */,
- );
- path = Source;
- sourceTree = "<group>";
- };
- 63E7DD7B1C518F9600D84B12 /* View Controllers */ = {
- isa = PBXGroup;
- children = (
- 63E7DD791C518F1700D84B12 /* FollowViewController.swift */,
- 63E7DD731C518BAD00D84B12 /* LoginViewController.swift */,
- 63E7DD771C518E0400D84B12 /* MessageViewController.swift */,
- 63E7DD751C518C9000D84B12 /* RegisterViewController.swift */,
- 6355FEC61BFE4FC600E07170 /* ViewControllerExtensions.swift */,
- );
- name = "View Controllers";
- sourceTree = "<group>";
- };
- 63E7DD7C1C518FC300D84B12 /* Custom Views */ = {
- isa = PBXGroup;
- children = (
- 63E7DD7D1C518FDD00D84B12 /* FormTextField.swift */,
- 63C9E5291C04F3B900C65F81 /* MessageTableViewCell.swift */,
- 63C9E5301C05184900C65F81 /* MessageTextView.swift */,
- );
- name = "Custom Views";
- sourceTree = "<group>";
- };
- 63E7DD7F1C51902F00D84B12 /* Supporting Files */ = {
- isa = PBXGroup;
- children = (
- 6355FECB1BFE4FC600E07170 /* Assets.xcassets */,
- 6355FED01BFE4FC600E07170 /* Info.plist */,
- );
- name = "Supporting Files";
- sourceTree = "<group>";
- };
- 63E7DD801C51903A00D84B12 /* Storyboards */ = {
- isa = PBXGroup;
- children = (
- 6355FEC81BFE4FC600E07170 /* Main.storyboard */,
- 6355FECD1BFE4FC600E07170 /* LaunchScreen.storyboard */,
- );
- name = Storyboards;
- sourceTree = "<group>";
- };
-/* End PBXGroup section */
-
-/* Begin PBXNativeTarget section */
- 6348D95A1C4EAC0B005C978C /* WatchSample */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 6348D97C1C4EAC0C005C978C /* Build configuration list for PBXNativeTarget "WatchSample" */;
- buildPhases = (
- 6348D9591C4EAC0B005C978C /* Resources */,
- 6348D97B1C4EAC0C005C978C /* Embed App Extensions */,
- );
- buildRules = (
- );
- dependencies = (
- 6348D96A1C4EAC0B005C978C /* PBXTargetDependency */,
- );
- name = WatchSample;
- productName = WatchSample;
- productReference = 6348D95B1C4EAC0B005C978C /* WatchSample.app */;
- productType = "com.apple.product-type.application.watchapp2";
- };
- 6348D9661C4EAC0B005C978C /* WatchSample Extension */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 6348D97A1C4EAC0C005C978C /* Build configuration list for PBXNativeTarget "WatchSample Extension" */;
- buildPhases = (
- 6348D9631C4EAC0B005C978C /* Sources */,
- 6348D9641C4EAC0B005C978C /* Frameworks */,
- 6348D9651C4EAC0B005C978C /* Resources */,
- 634855491C726AF8005FE016 /* Embed Frameworks */,
- );
- buildRules = (
- );
- dependencies = (
- 634855481C726AF7005FE016 /* PBXTargetDependency */,
- );
- name = "WatchSample Extension";
- productName = "WatchSample Extension";
- productReference = 6348D9671C4EAC0B005C978C /* WatchSample Extension.appex */;
- productType = "com.apple.product-type.watchkit2-extension";
- };
- 6355FEC01BFE4FC600E07170 /* ActivityFeed */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 6355FED31BFE4FC600E07170 /* Build configuration list for PBXNativeTarget "ActivityFeed" */;
- buildPhases = (
- 6355FEBD1BFE4FC600E07170 /* Sources */,
- 6355FEBE1BFE4FC600E07170 /* Frameworks */,
- 6355FEBF1BFE4FC600E07170 /* Resources */,
- 6348D97D1C4EAC0C005C978C /* Embed Watch Content */,
- 634855441C726AE9005FE016 /* Embed Frameworks */,
- );
- buildRules = (
- );
- dependencies = (
- 6348D9741C4EAC0C005C978C /* PBXTargetDependency */,
- 634855431C726AE9005FE016 /* PBXTargetDependency */,
- );
- name = ActivityFeed;
- productName = SDKSample;
- productReference = 6355FEC11BFE4FC600E07170 /* ActivityFeed.app */;
- productType = "com.apple.product-type.application";
- };
-/* End PBXNativeTarget section */
-
-/* Begin PBXProject section */
- 6355FEB91BFE4FC600E07170 /* Project object */ = {
- isa = PBXProject;
- attributes = {
- LastSwiftUpdateCheck = 0720;
- LastUpgradeCheck = 0710;
- ORGANIZATIONNAME = "Apigee Inc.";
- TargetAttributes = {
- 6348D95A1C4EAC0B005C978C = {
- CreatedOnToolsVersion = 7.2;
- };
- 6348D9661C4EAC0B005C978C = {
- CreatedOnToolsVersion = 7.2;
- };
- 6355FEC01BFE4FC600E07170 = {
- CreatedOnToolsVersion = 7.1.1;
- };
- };
- };
- buildConfigurationList = 6355FEBC1BFE4FC600E07170 /* Build configuration list for PBXProject "ActivityFeed" */;
- compatibilityVersion = "Xcode 3.2";
- developmentRegion = English;
- hasScannedForEncodings = 0;
- knownRegions = (
- en,
- Base,
- );
- mainGroup = 6355FEB81BFE4FC600E07170;
- productRefGroup = 6355FEC21BFE4FC600E07170 /* Products */;
- projectDirPath = "";
- projectReferences = (
- {
- ProductGroup = 634855291C726AD3005FE016 /* Products */;
- ProjectRef = 634855281C726AD3005FE016 /* UsergridSDK.xcodeproj */;
- },
- );
- projectRoot = "";
- targets = (
- 6355FEC01BFE4FC600E07170 /* ActivityFeed */,
- 6348D95A1C4EAC0B005C978C /* WatchSample */,
- 6348D9661C4EAC0B005C978C /* WatchSample Extension */,
- );
- };
-/* End PBXProject section */
-
-/* Begin PBXReferenceProxy section */
- 634855331C726AD3005FE016 /* UsergridSDK.framework */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.framework;
- path = UsergridSDK.framework;
- remoteRef = 634855321C726AD3005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 634855351C726AD3005FE016 /* UsergridSDK.framework */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.framework;
- path = UsergridSDK.framework;
- remoteRef = 634855341C726AD3005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 634855371C726AD3005FE016 /* UsergridSDK.framework */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.framework;
- path = UsergridSDK.framework;
- remoteRef = 634855361C726AD3005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 634855391C726AD3005FE016 /* UsergridSDK.framework */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.framework;
- path = UsergridSDK.framework;
- remoteRef = 634855381C726AD3005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 6348553B1C726AD3005FE016 /* UsergridSDK_TVOS_Tests.xctest */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.cfbundle;
- path = UsergridSDK_TVOS_Tests.xctest;
- remoteRef = 6348553A1C726AD3005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 6348553D1C726AD3005FE016 /* UsergridSDK_OSX_Tests.xctest */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.cfbundle;
- path = UsergridSDK_OSX_Tests.xctest;
- remoteRef = 6348553C1C726AD3005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 6348553F1C726AD3005FE016 /* UsergridSDK_iOS_Tests.xctest */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.cfbundle;
- path = UsergridSDK_iOS_Tests.xctest;
- remoteRef = 6348553E1C726AD3005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
-/* End PBXReferenceProxy section */
-
-/* Begin PBXResourcesBuildPhase section */
- 6348D9591C4EAC0B005C978C /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 6348D9611C4EAC0B005C978C /* Assets.xcassets in Resources */,
- 6348D95F1C4EAC0B005C978C /* Interface.storyboard in Resources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 6348D9651C4EAC0B005C978C /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 6348D9711C4EAC0C005C978C /* Assets.xcassets in Resources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 6355FEBF1BFE4FC600E07170 /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 6355FECF1BFE4FC600E07170 /* LaunchScreen.storyboard in Resources */,
- 6355FECC1BFE4FC600E07170 /* Assets.xcassets in Resources */,
- 6355FECA1BFE4FC600E07170 /* Main.storyboard in Resources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXResourcesBuildPhase section */
-
-/* Begin PBXSourcesBuildPhase section */
- 6348D9631C4EAC0B005C978C /* Sources */ = {
- isa = PBXSourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 6348D9871C4EC1FD005C978C /* UsergridManager.swift in Sources */,
- 63CD143E1C505EC500C00076 /* ActivityEntity.swift in Sources */,
- 6348D96F1C4EAC0B005C978C /* ExtensionDelegate.swift in Sources */,
- 6348D96D1C4EAC0B005C978C /* InterfaceController.swift in Sources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
- 6355FEBD1BFE4FC600E07170 /* Sources */ = {
- isa = PBXSourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 63E7DD741C518BAD00D84B12 /* LoginViewController.swift in Sources */,
- 63E7DD781C518E0400D84B12 /* MessageViewController.swift in Sources */,
- 6348D9861C4EC1FD005C978C /* UsergridManager.swift in Sources */,
- 6355FEC71BFE4FC600E07170 /* ViewControllerExtensions.swift in Sources */,
- 63E7DD761C518C9000D84B12 /* RegisterViewController.swift in Sources */,
- 6355FEC51BFE4FC600E07170 /* AppDelegate.swift in Sources */,
- 63E7DD7A1C518F1700D84B12 /* FollowViewController.swift in Sources */,
- 63CD143D1C505EC500C00076 /* ActivityEntity.swift in Sources */,
- 63C9E5311C05184900C65F81 /* MessageTextView.swift in Sources */,
- 63C9E52A1C04F3B900C65F81 /* MessageTableViewCell.swift in Sources */,
- 63E7DD7E1C518FDD00D84B12 /* FormTextField.swift in Sources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXSourcesBuildPhase section */
-
-/* Begin PBXTargetDependency section */
- 634855431C726AE9005FE016 /* PBXTargetDependency */ = {
- isa = PBXTargetDependency;
- name = "UsergridSDK iOS";
- targetProxy = 634855421C726AE9005FE016 /* PBXContainerItemProxy */;
- };
- 634855481C726AF7005FE016 /* PBXTargetDependency */ = {
- isa = PBXTargetDependency;
- name = "UsergridSDK watchOS";
- targetProxy = 634855471C726AF7005FE016 /* PBXContainerItemProxy */;
- };
- 6348D96A1C4EAC0B005C978C /* PBXTargetDependency */ = {
- isa = PBXTargetDependency;
- target = 6348D9661C4EAC0B005C978C /* WatchSample Extension */;
- targetProxy = 6348D9691C4EAC0B005C978C /* PBXContainerItemProxy */;
- };
- 6348D9741C4EAC0C005C978C /* PBXTargetDependency */ = {
- isa = PBXTargetDependency;
- target = 6348D95A1C4EAC0B005C978C /* WatchSample */;
- targetProxy = 6348D9731C4EAC0C005C978C /* PBXContainerItemProxy */;
- };
-/* End PBXTargetDependency section */
-
-/* Begin PBXVariantGroup section */
- 6348D95D1C4EAC0B005C978C /* Interface.storyboard */ = {
- isa = PBXVariantGroup;
- children = (
- 6348D95E1C4EAC0B005C978C /* Base */,
- );
- name = Interface.storyboard;
- sourceTree = "<group>";
- };
- 6355FEC81BFE4FC600E07170 /* Main.storyboard */ = {
- isa = PBXVariantGroup;
- children = (
- 6355FEC91BFE4FC600E07170 /* Base */,
- );
- name = Main.storyboard;
- sourceTree = "<group>";
- };
- 6355FECD1BFE4FC600E07170 /* LaunchScreen.storyboard */ = {
- isa = PBXVariantGroup;
- children = (
- 6355FECE1BFE4FC600E07170 /* Base */,
- );
- name = LaunchScreen.storyboard;
- sourceTree = "<group>";
- };
-/* End PBXVariantGroup section */
-
-/* Begin XCBuildConfiguration section */
- 6348D9761C4EAC0C005C978C /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
- IBSC_MODULE = WatchSample_Extension;
- INFOPLIST_FILE = WatchSample/Info.plist;
- PRODUCT_BUNDLE_IDENTIFIER = com.usergrid.activityfeed.watchkitapp;
- PRODUCT_NAME = "$(TARGET_NAME)";
- SDKROOT = watchos;
- SKIP_INSTALL = YES;
- TARGETED_DEVICE_FAMILY = 4;
- WATCHOS_DEPLOYMENT_TARGET = 2.1;
- };
- name = Debug;
- };
- 6348D9771C4EAC0C005C978C /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
- IBSC_MODULE = WatchSample_Extension;
- INFOPLIST_FILE = WatchSample/Info.plist;
- PRODUCT_BUNDLE_IDENTIFIER = com.usergrid.activityfeed.watchkitapp;
- PRODUCT_NAME = "$(TARGET_NAME)";
- SDKROOT = watchos;
- SKIP_INSTALL = YES;
- TARGETED_DEVICE_FAMILY = 4;
- WATCHOS_DEPLOYMENT_TARGET = 2.1;
- };
- name = Release;
- };
- 6348D9781C4EAC0C005C978C /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
- FRAMEWORK_SEARCH_PATHS = "$(inherited)";
- INFOPLIST_FILE = "WatchSample Extension/Info.plist";
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @executable_path/../../Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = com.usergrid.activityfeed.watchkitapp.watchkitextension;
- PRODUCT_NAME = "${TARGET_NAME}";
- SDKROOT = watchos;
- SKIP_INSTALL = YES;
- TARGETED_DEVICE_FAMILY = 4;
- WATCHOS_DEPLOYMENT_TARGET = 2.1;
- };
- name = Debug;
- };
- 6348D9791C4EAC0C005C978C /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
- FRAMEWORK_SEARCH_PATHS = "$(inherited)";
- INFOPLIST_FILE = "WatchSample Extension/Info.plist";
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @executable_path/../../Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = com.usergrid.activityfeed.watchkitapp.watchkitextension;
- PRODUCT_NAME = "${TARGET_NAME}";
- SDKROOT = watchos;
- SKIP_INSTALL = YES;
- TARGETED_DEVICE_FAMILY = 4;
- WATCHOS_DEPLOYMENT_TARGET = 2.1;
- };
- name = Release;
- };
- 6355FED11BFE4FC600E07170 /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ALWAYS_SEARCH_USER_PATHS = NO;
- CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
- CLANG_CXX_LIBRARY = "libc++";
- CLANG_ENABLE_MODULES = YES;
- CLANG_ENABLE_OBJC_ARC = YES;
- CLANG_WARN_BOOL_CONVERSION = YES;
- CLANG_WARN_CONSTANT_CONVERSION = YES;
- CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
- CLANG_WARN_EMPTY_BODY = YES;
- CLANG_WARN_ENUM_CONVERSION = YES;
- CLANG_WARN_INT_CONVERSION = YES;
- CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
- CLANG_WARN_UNREACHABLE_CODE = YES;
- CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- COPY_PHASE_STRIP = NO;
- DEBUG_INFORMATION_FORMAT = dwarf;
- ENABLE_STRICT_OBJC_MSGSEND = YES;
- ENABLE_TESTABILITY = YES;
- GCC_C_LANGUAGE_STANDARD = gnu99;
- GCC_DYNAMIC_NO_PIC = NO;
- GCC_NO_COMMON_BLOCKS = YES;
- GCC_OPTIMIZATION_LEVEL = 0;
- GCC_PREPROCESSOR_DEFINITIONS = (
- "DEBUG=1",
- "$(inherited)",
- );
- GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
- GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
- GCC_WARN_UNDECLARED_SELECTOR = YES;
- GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
- GCC_WARN_UNUSED_FUNCTION = YES;
- GCC_WARN_UNUSED_VARIABLE = YES;
- IPHONEOS_DEPLOYMENT_TARGET = 9.1;
- MTL_ENABLE_DEBUG_INFO = YES;
- ONLY_ACTIVE_ARCH = YES;
- SDKROOT = iphoneos;
- SWIFT_OPTIMIZATION_LEVEL = "-Onone";
- };
- name = Debug;
- };
- 6355FED21BFE4FC600E07170 /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ALWAYS_SEARCH_USER_PATHS = NO;
- CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
- CLANG_CXX_LIBRARY = "libc++";
- CLANG_ENABLE_MODULES = YES;
- CLANG_ENABLE_OBJC_ARC = YES;
- CLANG_WARN_BOOL_CONVERSION = YES;
- CLANG_WARN_CONSTANT_CONVERSION = YES;
- CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
- CLANG_WARN_EMPTY_BODY = YES;
- CLANG_WARN_ENUM_CONVERSION = YES;
- CLANG_WARN_INT_CONVERSION = YES;
- CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
- CLANG_WARN_UNREACHABLE_CODE = YES;
- CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- COPY_PHASE_STRIP = NO;
- DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
- ENABLE_NS_ASSERTIONS = NO;
- ENABLE_STRICT_OBJC_MSGSEND = YES;
- GCC_C_LANGUAGE_STANDARD = gnu99;
- GCC_NO_COMMON_BLOCKS = YES;
- GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
- GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
- GCC_WARN_UNDECLARED_SELECTOR = YES;
- GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
- GCC_WARN_UNUSED_FUNCTION = YES;
- GCC_WARN_UNUSED_VARIABLE = YES;
- IPHONEOS_DEPLOYMENT_TARGET = 9.1;
- MTL_ENABLE_DEBUG_INFO = NO;
- SDKROOT = iphoneos;
- VALIDATE_PRODUCT = YES;
- };
- name = Release;
- };
- 6355FED41BFE4FC600E07170 /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
- CLANG_ENABLE_MODULES = YES;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
- INFOPLIST_FILE = Source/Info.plist;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = com.usergrid.activityfeed;
- PRODUCT_NAME = ActivityFeed;
- PROVISIONING_PROFILE = "";
- SWIFT_INSTALL_OBJC_HEADER = NO;
- SWIFT_OBJC_BRIDGING_HEADER = "";
- SWIFT_OPTIMIZATION_LEVEL = "-Onone";
- };
- name = Debug;
- };
- 6355FED51BFE4FC600E07170 /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
- CLANG_ENABLE_MODULES = YES;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
- INFOPLIST_FILE = Source/Info.plist;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = com.usergrid.activityfeed;
- PRODUCT_NAME = ActivityFeed;
- PROVISIONING_PROFILE = "";
- SWIFT_INSTALL_OBJC_HEADER = NO;
- SWIFT_OBJC_BRIDGING_HEADER = "";
- };
- name = Release;
- };
-/* End XCBuildConfiguration section */
-
-/* Begin XCConfigurationList section */
- 6348D97A1C4EAC0C005C978C /* Build configuration list for PBXNativeTarget "WatchSample Extension" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 6348D9781C4EAC0C005C978C /* Debug */,
- 6348D9791C4EAC0C005C978C /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 6348D97C1C4EAC0C005C978C /* Build configuration list for PBXNativeTarget "WatchSample" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 6348D9761C4EAC0C005C978C /* Debug */,
- 6348D9771C4EAC0C005C978C /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 6355FEBC1BFE4FC600E07170 /* Build configuration list for PBXProject "ActivityFeed" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 6355FED11BFE4FC600E07170 /* Debug */,
- 6355FED21BFE4FC600E07170 /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 6355FED31BFE4FC600E07170 /* Build configuration list for PBXNativeTarget "ActivityFeed" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 6355FED41BFE4FC600E07170 /* Debug */,
- 6355FED51BFE4FC600E07170 /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
-/* End XCConfigurationList section */
- };
- rootObject = 6355FEB91BFE4FC600E07170 /* Project object */;
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcodeproj/project.xcworkspace/contents.xcworkspacedata
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcodeproj/project.xcworkspace/contents.xcworkspacedata
deleted file mode 100644
index 3603482..0000000
--- a/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcodeproj/project.xcworkspace/contents.xcworkspacedata
+++ /dev/null
@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
- version = "1.0">
- <FileRef
- location = "self:SDKSample.xcodeproj">
- </FileRef>
-</Workspace>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcworkspace/contents.xcworkspacedata
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcworkspace/contents.xcworkspacedata b/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcworkspace/contents.xcworkspacedata
deleted file mode 100644
index 1344aa3..0000000
--- a/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcworkspace/contents.xcworkspacedata
+++ /dev/null
@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
- version = "1.0">
- <FileRef
- location = "group:ActivityFeed.xcodeproj">
- </FileRef>
-</Workspace>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcworkspace/xcshareddata/ActivityFeed.xcscmblueprint
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcworkspace/xcshareddata/ActivityFeed.xcscmblueprint b/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcworkspace/xcshareddata/ActivityFeed.xcscmblueprint
deleted file mode 100644
index cd872fc..0000000
--- a/sdks/swift/Samples/ActivityFeed/ActivityFeed.xcworkspace/xcshareddata/ActivityFeed.xcscmblueprint
+++ /dev/null
@@ -1,30 +0,0 @@
-{
- "DVTSourceControlWorkspaceBlueprintPrimaryRemoteRepositoryKey" : "E28DB29D4B8B9FB468FB340D2257B16682332D89",
- "DVTSourceControlWorkspaceBlueprintWorkingCopyRepositoryLocationsKey" : {
-
- },
- "DVTSourceControlWorkspaceBlueprintWorkingCopyStatesKey" : {
- "E28DB29D4B8B9FB468FB340D2257B16682332D89" : 0,
- "AD57BFF635DD66DF5DF78257082332592EB51D31" : 0
- },
- "DVTSourceControlWorkspaceBlueprintIdentifierKey" : "F8EC72FE-9B21-4617-8470-0D30DC16A66E",
- "DVTSourceControlWorkspaceBlueprintWorkingCopyPathsKey" : {
- "E28DB29D4B8B9FB468FB340D2257B16682332D89" : "swift\/",
- "AD57BFF635DD66DF5DF78257082332592EB51D31" : ".."
- },
- "DVTSourceControlWorkspaceBlueprintNameKey" : "ActivityFeed",
- "DVTSourceControlWorkspaceBlueprintVersion" : 204,
- "DVTSourceControlWorkspaceBlueprintRelativePathToProjectKey" : "Samples\/ActivityFeed\/ActivityFeed.xcworkspace",
- "DVTSourceControlWorkspaceBlueprintRemoteRepositoriesKey" : [
- {
- "DVTSourceControlWorkspaceBlueprintRemoteRepositoryURLKey" : "github.com:RobertWalsh\/usergrid.git",
- "DVTSourceControlWorkspaceBlueprintRemoteRepositorySystemKey" : "com.apple.dt.Xcode.sourcecontrol.Git",
- "DVTSourceControlWorkspaceBlueprintRemoteRepositoryIdentifierKey" : "AD57BFF635DD66DF5DF78257082332592EB51D31"
- },
- {
- "DVTSourceControlWorkspaceBlueprintRemoteRepositoryURLKey" : "github.com:RobertWalsh\/UsergridSDK.git",
- "DVTSourceControlWorkspaceBlueprintRemoteRepositorySystemKey" : "com.apple.dt.Xcode.sourcecontrol.Git",
- "DVTSourceControlWorkspaceBlueprintRemoteRepositoryIdentifierKey" : "E28DB29D4B8B9FB468FB340D2257B16682332D89"
- }
- ]
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/Podfile
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/Podfile b/sdks/swift/Samples/ActivityFeed/Podfile
deleted file mode 100644
index 23d5db6..0000000
--- a/sdks/swift/Samples/ActivityFeed/Podfile
+++ /dev/null
@@ -1,8 +0,0 @@
-use_frameworks!
-inhibit_all_warnings!
-
-target 'ActivityFeed' do
- platform :ios, '9.0'
- pod 'SlackTextViewController'
-end
-
[07/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/index.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/index.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/index.html
deleted file mode 100644
index b49cde5..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/index.html
+++ /dev/null
@@ -1,927 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title> 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 title=" 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" />
- 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">
-
- <a href='#usergridsdk' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h1 id='usergridsdk'>UsergridSDK</h1>
-
-<p><a href="http://cocoadocs.org/docsets/UsergridSDK"><img src="https://img.shields.io/cocoapods/p/UsergridSDK.svg?style=flat" alt="Platform"></a>
-<a href="https://cocoapods.org/pods/UsergridSDK"><img src="https://img.shields.io/cocoapods/v/UsergridSDK.svg" alt="CocoaPods Compatible"></a></p>
-
-<p>Usergrid SDK written in Swift </p>
-<a href='#requirements' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='requirements'>Requirements</h2>
-
-<blockquote>
-<p><strong>While the Usergrid SDK is written in Swift, the functionality remains compatible with Objective-C.</strong></p>
-
-<p><strong>Use <code>#import <UsergridSDK/UsergridSDK-Swift.h></code> in your Objective-C files to enable the use of the SDK.</strong></p>
-</blockquote>
-
-<ul>
-<li>iOS 8.0+ / Mac OS X 10.11+ / tvOS 9.1+ / watchOS 2.1+</li>
-<li>Xcode 7.1+</li>
-</ul>
-<a href='#installation' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='installation'>Installation</h2>
-
-<blockquote>
-<p><strong>Embedded frameworks require a minimum deployment target of iOS 8 or OS X Mavericks (10.9).</strong></p>
-</blockquote>
-<a href='#cocoapods' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='cocoapods'>CocoaPods</h3>
-
-<blockquote>
-<p><strong>CocoaPods 0.39.0+ is required to build the UsergridSDK library.</strong></p>
-</blockquote>
-
-<p>To integrate the UsergridSDK into your Xcode project using CocoaPods, specify it in your <code>Podfile</code>:</p>
-<pre class="highlight ruby"><code><span class="n">platform</span> <span class="ss">:ios</span><span class="p">,</span> <span class="s1">'8.0'</span>
-<span class="n">use_frameworks!</span>
-
-<span class="n">pod</span> <span class="s1">'UsergridSDK'</span>
-</code></pre>
-
-<p>Then, run the following command:</p>
-<pre class="highlight shell"><code><span class="gp">$ </span>pod install
-</code></pre>
-<a href='#embedded_framework' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='embedded_framework'>Embedded Framework</h3>
-
-<ul>
-<li>Open up Terminal, <code>cd</code> into your top-level project directory, and run the following command <q>if</q> your project is not initialized as a git repository:</li>
-</ul>
-<pre class="highlight shell"><code><span class="gp">$ </span>git init
-</code></pre>
-
-<ul>
-<li>Add UsergridSDK as a git submodule by running the following command:</li>
-</ul>
-<pre class="highlight shell"><code><span class="gp">$ </span>git submodule add https://github.com/apache/usergrid
-</code></pre>
-
-<ul>
-<li>Open the <code>sdks/swift</code> folder, and drag the <code>UsergridSDK.xcodeproj</code> into the Project Navigator of your application’s Xcode project.</li>
-</ul>
-
-<blockquote>
-<p>It should appear nested underneath your application’s blue project icon.</p>
-</blockquote>
-
-<ul>
-<li>Select the <code>UsergridSDK.xcodeproj</code> in the Project Navigator and verify the deployment target matches that of your application target.</li>
-<li>Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the <q>Targets</q> heading in the sidebar.</li>
-<li>In the tab bar at the top of that window, open the <q>General</q> panel.</li>
-<li>Click on the <code>+</code> button under the <q>Embedded Binaries</q> section.</li>
-<li>Select the <code>UsergridSDK.framework</code>.</li>
-</ul>
-
-<blockquote>
-<p>The <code>UsergridSDK.framework</code> is automatically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.</p>
-</blockquote>
-<a href='#documentation' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='documentation'>Documentation</h2>
-
-<p>The documentation for this library is available <a href="http://cocoadocs.org/docsets/UsergridSDK">here</a>.</p>
-<a href='#initialization' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='initialization'>Initialization</h2>
-
-<p>There are two different ways of initializing the Usergrid Swift SDK: </p>
-
-<ol>
-<li>The singleton pattern is both convenient and enables the developer to use a globally available and always-initialized instance of Usergrid.</li>
-</ol>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="nf">initSharedInstance</span><span class="p">(</span><span class="nv">orgId</span><span class="p">:</span> <span class="s">"orgId"</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="s">"appId"</span><span class="p">)</span>
-</code></pre>
-
-<ol>
-<li>The Instance pattern enables the developer to manage instances of the Usergrid client independently and in an isolated fashion. The primary use-case for this is when an application connects to multiple Usergrid targets.</li>
-</ol>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">client</span> <span class="o">=</span> <span class="kt">UsergridClient</span><span class="p">(</span><span class="nv">orgId</span><span class="p">:</span> <span class="s">"orgId"</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="s">"appId"</span><span class="p">)</span>
-</code></pre>
-
-<p><em>Note: Examples in this readme assume you are using the <code>Usergrid</code> shared instance. If you’ve implemented the instance pattern instead, simply replace <code>Usergrid</code> with your client instance variable.</em></p>
-<a href='#push_notifications' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='push_notifications'>Push Notifications</h2>
-
-<p><em>Note: You must have an Apple Developer account along with valid provisioning profiles set in order to receive push notifications.</em></p>
-
-<p>In order to utilize Usergrid push notifications, you must register the device with an Usergrid push notifier identifier.</p>
-
-<blockquote>
-<p>For a more thorough example of recieving push notifications and sending push notifications (from the device) refer to the Push sample app located in the <code>/Samples</code> folder.</p>
-</blockquote>
-
-<p>The following code snippet shows how you would register for push notifications and apply the push token within the application delegate.</p>
-<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">UsergridSDK</span>
-
-<span class="kd">@UIApplicationMain</span> <span class="kd">class</span> <span class="kt">AppDelegate</span><span class="p">:</span> <span class="kt">UIResponder</span><span class="p">,</span> <span class="kt">UIApplicationDelegate</span> <span class="p">{</span>
-
- <span class="kd">func</span> <span class="nf">application</span><span class="p">(</span><span class="nv">application</span><span class="p">:</span> <span class="kt">UIApplication</span><span class="p">,</span> <span class="n">didFinishLaunchingWithOptions</span> <span class="nv">launchOptions</span><span class="p">:</span> <span class="p">[</span><span class="kt">NSObject</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?)</span> <span class="o">-></span> <span class="kt">Bool</span> <span class="p">{</span>
-
- <span class="c1">// Initialize the shared instance of Usergrid.</span>
- <span class="kt">Usergrid</span><span class="o">.</span><span class="nf">initSharedInstance</span><span class="p">(</span><span class="nv">orgId</span><span class="p">:</span><span class="s">"orgId"</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="s">"appId"</span><span class="p">)</span>
-
- <span class="c1">// Register for APN</span>
- <span class="n">application</span><span class="o">.</span><span class="nf">registerUserNotificationSettings</span><span class="p">(</span><span class="kt">UIUserNotificationSettings</span><span class="p">(</span> <span class="nv">forTypes</span><span class="p">:</span> <span class="p">[</span><span class="o">.</span><span class="kt">Alert</span><span class="p">,</span> <span class="o">.</span><span class="kt">Badge</span><span class="p">,</span> <span class="o">.</span><span class="kt">Sound</span><span class="p">],</span> <span class="nv">categories</span><span class="p">:</span> <span class="kc">nil</span><span class="p">))</span>
- <span class="n">application</span><span class="o">.</span><span class="nf">registerForRemoteNotifications</span><span class="p">()</span>
-
- <span class="k">return</span> <span class="kc">true</span>
- <span class="p">}</span>
-
- <span class="kd">func</span> <span class="nf">application</span><span class="p">(</span><span class="nv">application</span><span class="p">:</span> <span class="kt">UIApplication</span><span class="p">,</span> <span class="n">didRegisterForRemoteNotificationsWithDeviceToken</span> <span class="nv">deviceToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">)</span> <span class="p">{</span>
- <span class="kt">Usergrid</span><span class="o">.</span><span class="nf">applyPushToken</span><span class="p">(</span><span class="n">deviceToken</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="s">"notifierId"</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// The push notification is now added to Usergrid for this device and this device will now be able to recieve notifications.</span>
- <span class="p">}</span>
- <span class="p">}</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#restful_operations' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='restful_operations'>RESTful operations</h2>
-
-<p>When making any RESTful call, a <code>type</code> parameter (or <code>path</code>) is always required. Whether you specify this as an argument or in an object as a parameter is up to you.</p>
-<a href='#get' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='get'>GET</h3>
-
-<ul>
-<li>To get entities in a collection:</li>
-</ul>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="kt">GET</span><span class="p">(</span><span class="s">"collection"</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="k">var</span> <span class="nv">entities</span><span class="p">:</span> <span class="p">[</span><span class="kt">UsergridEntity</span><span class="p">]?</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">entities</span>
-<span class="p">}</span>
-</code></pre>
-
-<ul>
-<li>To get a specific entity in a collection by uuid or name:</li>
-</ul>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="kt">GET</span><span class="p">(</span><span class="s">"collection"</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span><span class="s">"<uuid-or-name>"</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="k">var</span> <span class="nv">entity</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">?</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">entity</span><span class="p">?</span>
-<span class="p">}</span>
-</code></pre>
-
-<ul>
-<li>To get specific entities in a collection by passing a <code>UsergridQuery</code> object:</li>
-</ul>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span><span class="o">.</span><span class="nf">gt</span><span class="p">(</span><span class="s">"weight"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="mf">2.4</span><span class="p">)</span>
- <span class="o">.</span><span class="nf">contains</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"bl*"</span><span class="p">)</span>
- <span class="o">.</span><span class="nf">not</span><span class="p">()</span>
- <span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"blue"</span><span class="p">)</span>
- <span class="o">.</span><span class="nf">or</span><span class="p">()</span>
- <span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"orange"</span><span class="p">)</span>
-
-<span class="c1">// this will build out the following query:</span>
-<span class="c1">// select * where weight > 2.4 and color contains 'bl*' and not color = 'blue' or color = 'orange'</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">GET</span><span class="p">(</span><span class="n">query</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="k">var</span> <span class="nv">entities</span><span class="p">:</span> <span class="p">[</span><span class="kt">UsergridEntity</span><span class="p">]?</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">entities</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#post_and_put' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='post_and_put'>POST and PUT</h3>
-
-<p>POST and PUT requests both require a JSON body payload. You can pass either a Swift object or a <code>UsergridEntity</code> instance. While the former works in principle, best practise is to use a <code>UsergridEntity</code> wherever practical. When an entity has a uuid or name property and already exists on the server, use a PUT request to update it. If it does not, use POST to create it.</p>
-
-<ul>
-<li>To create a new entity in a collection (<strong>POST</strong>):</li>
-</ul>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">entity</span> <span class="o">=</span> <span class="kt">UsergridEntity</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="s">"restaurant"</span><span class="p">,</span> <span class="nv">propertyDict</span><span class="p">:</span> <span class="p">[</span><span class="s">"restaurant"</span><span class="p">:</span> <span class="s">"Dino's Deep Dish"</span><span class="p">,</span><span class="s">"cuisine"</span><span class="p">:</span> <span class="s">"pizza"</span><span class="p">])</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">POST</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// entity should now have a uuid property and be created</span>
-<span class="p">}</span>
-
-<span class="c1">// you can also POST an array of entities:</span>
-
-<span class="k">var</span> <span class="nv">entities</span> <span class="o">=</span> <span class="p">[</span><span class="kt">UsergridEntity</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="s">"restaurant"</span><span class="p">,</span> <span class="nv">propertyDict</span><span class="p">:[</span><span class="s">"restaurant"</span><span class="p">:</span> <span class="s">"Dino's Deep Dish"</span><span class="p">,</span><span class="s">"cuisine"</span><span class="p">:</span> <span class="s">"pizza"</span><span class="p">]),</span>
- <span class="kt">UsergridEntity</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="s">"restaurant"</span><span class="p">,</span> <span class="nv">propertyDict</span><span class="p">:[</span><span class="s">"restaurant"</span><span class="p">:</span> <span class="s">"Pizza da Napoli"</span><span class="p">,</span><span class="s">"cuisine"</span><span class="p">:</span> <span class="s">"pizza"</span><span class="p">])]</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">POST</span><span class="p">(</span><span class="n">entities</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// response.entities should now contain now valid posted entities.</span>
-<span class="p">}</span>
-</code></pre>
-
-<ul>
-<li>To update an entity in a collection (<strong>PUT</strong>):</li>
-</ul>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">entity</span> <span class="o">=</span> <span class="kt">UsergridEntity</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="s">"restaurant"</span><span class="p">,</span> <span class="nv">propertyDict</span><span class="p">:[</span><span class="s">"restaurant"</span><span class="p">:</span> <span class="s">"Dino's Deep Dish"</span><span class="p">,</span> <span class="s">"cuisine"</span><span class="p">:</span> <span class="s">"pizza"</span><span class="p">])</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">POST</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="k">if</span> <span class="k">let</span> <span class="nv">responseEntity</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">entity</span> <span class="p">{</span>
- <span class="n">responseEntity</span><span class="p">[</span><span class="s">"owner"</span><span class="p">]</span> <span class="o">=</span> <span class="s">"Mia Carrara"</span>
- <span class="kt">Usergrid</span><span class="o">.</span><span class="kt">PUT</span><span class="p">(</span><span class="n">responseEntity</span><span class="p">)</span> <span class="p">{</span> <span class="p">(</span><span class="n">response</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span> <span class="k">in</span>
- <span class="c1">// entity now has the property 'owner'</span>
- <span class="p">}</span>
- <span class="p">}</span>
-<span class="p">}</span>
-
-<span class="c1">// or update a set of entities by passing a UsergridQuery object</span>
-
-<span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"restaurants"</span><span class="p">)</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"cuisine"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"italian"</span><span class="p">)</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">PUT</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="nv">jsonBody</span><span class="p">:</span> <span class="p">[</span><span class="s">"keywords"</span><span class="p">:[</span><span class="s">"pasta"</span><span class="p">]])</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
-
- <span class="cm">/* the first 10 entities matching this query criteria will be updated:
- e.g.:
- [
- {
- "type": "restaurant",
- "restaurant": "Il Tarazzo",
- "cuisine": "italian",
- "keywords": ["pasta"]
- },
- {
- "type": "restaurant",
- "restaurant": "Cono Sur Pizza & Pasta",
- "cuisine": "italian",
- "keywords": ["pasta"]
- }
- ]
- */</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#delete' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='delete'>DELETE</h3>
-
-<p>DELETE requests require either a specific entity or a <code>UsergridQuery</code> object to be passed as an argument.</p>
-
-<ul>
-<li>To delete a specific entity in a collection by uuid or name:</li>
-</ul>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="kt">DELETE</span><span class="p">(</span><span class="s">"collection"</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="s">"<uuid-or-name>"</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// if successful, entity will now be deleted</span>
-<span class="p">})</span>
-</code></pre>
-
-<ul>
-<li>To specific entities in a collection to delete by passing a <code>UsergridQuery</code> object:</li>
-</ul>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"black"</span><span class="p">)</span>
- <span class="o">.</span><span class="nf">or</span><span class="p">()</span>
- <span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"white"</span><span class="p">)</span>
-
-<span class="c1">// this will build out the following query:</span>
-<span class="c1">// select * where color = 'black' or color = 'white'</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">DELETE</span><span class="p">(</span><span class="n">query</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// the first 10 entities matching this query criteria will be deleted</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#entity_operations_and_convenience_methods' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='entity_operations_and_convenience_methods'>Entity operations and convenience methods</h2>
-
-<p><code>UsergridEntity</code> has a number of helper/convenience methods to make working with entities more convenient.</p>
-<a href='#reload' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='reload'>reload()</h3>
-
-<p>Reloads the entity from the server:</p>
-<pre class="highlight swift"><code><span class="n">entity</span><span class="o">.</span><span class="nf">reload</span><span class="p">()</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// entity is now reloaded from the server</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#save' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='save'>save()</h3>
-
-<p>Saves (or creates) the entity on the server:</p>
-<pre class="highlight swift"><code><span class="n">entity</span><span class="p">[</span><span class="s">"aNewProperty"</span><span class="p">]</span> <span class="o">=</span> <span class="s">"A new value"</span>
-<span class="n">entity</span><span class="o">.</span><span class="nf">save</span><span class="p">()</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// entity is now updated on the server</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#remove' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='remove'>remove()</h3>
-
-<p>Deletes the entity from the server:</p>
-<pre class="highlight swift"><code><span class="n">entity</span><span class="o">.</span><span class="nf">remove</span><span class="p">()</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// entity is now deleted on the server and the local instance should be destroyed</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#authentication_current_user_and_auth_fallback' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='authentication_current_user_and_auth_fallback'>Authentication, current user, and auth-fallback</h2>
-<a href='#appauth_and_authenticateapp' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='appauth_and_authenticateapp'>appAuth and authenticateApp()</h3>
-
-<p><code>Usergrid</code> can use the app client ID and secret that were passed upon initialization and automatically retrieve an app-level token for these credentials.</p>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="nf">setAppAuth</span><span class="p">(</span><span class="s">"<client-id>"</span><span class="p">,</span> <span class="s">"<client-secret>"</span><span class="p">)</span>
-<span class="kt">Usergrid</span><span class="o">.</span><span class="nf">authenticateApp</span><span class="p">()</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// Usergrid.appAuth is authenticated automatically when this call is successful</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#currentuser_userauth_and_authenticateuser' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='currentuser_userauth_and_authenticateuser'>currentUser, userAuth, and authenticateUser()</h3>
-
-<p><code>Usergrid</code> has a special <code>currentUser</code> property. </p>
-
-<blockquote>
-<p>The current user is stored within the keychain so app relaunches will persist the user’s login and token information. To adjust this feature edit the <code>Usergrid.persistCurrentUserInKeychain</code> property upon initialization.</p>
-</blockquote>
-
-<p>By default, when calling <code>authenticateUser()</code>, <code>.currentUser</code> will be set to this user if the authentication flow is successful.</p>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">userAuth</span> <span class="o">=</span> <span class="kt">UsergridUserAuth</span><span class="p">(</span><span class="nv">username</span><span class="p">:</span> <span class="s">"<username>"</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="s">"<password>"</span><span class="p">)</span>
-<span class="kt">Usergrid</span><span class="o">.</span><span class="nf">authenticateUser</span><span class="p">(</span><span class="n">userAuth</span><span class="p">)</span> <span class="p">{</span> <span class="n">auth</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">error</span> <span class="k">in</span>
- <span class="c1">// Usergrid.currentUser is set to the authenticated user and the token is stored within that context</span>
-<span class="p">}</span>
-</code></pre>
-
-<p>If you want to utilize authenticateUser without setting as the current user, simply pass a <code>false</code> boolean value as the second parameter:</p>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">userAuth</span> <span class="o">=</span> <span class="kt">UsergridUserAuth</span><span class="p">(</span><span class="nv">username</span><span class="p">:</span> <span class="s">"<username>"</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="s">"<password>"</span><span class="p">)</span>
-<span class="kt">Usergrid</span><span class="o">.</span><span class="nf">authenticateUser</span><span class="p">(</span><span class="n">userAuth</span><span class="p">,</span><span class="nv">setAsCurrentUser</span><span class="p">:</span> <span class="kc">false</span><span class="p">)</span> <span class="p">{</span> <span class="n">auth</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">error</span> <span class="k">in</span>
- <span class="c1">// user is authenticated but Usergrid.currentUser is not set.</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#authfallback' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='authfallback'>authFallback</h3>
-
-<p>Auth-fallback defines what the client should do when a user token is not present. </p>
-
-<p>By default, <code>Usergrid.authFallback</code> is set to <code>.None</code>, whereby when a token is <em>not</em> present, an API call will be performed unauthenticated. </p>
-
-<p>If instead <code>Usergrid.authFallback</code> is set to <code>.App</code>, the API call will instead be performed using client credentials, <em>if</em> they’re available (i.e. <code>authenticateApp()</code> was performed at some point). </p>
-<a href='#usingauth' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='usingauth'>usingAuth()</h3>
-
-<p>At times it is desireable to have complete, granular control over the authentication context of an API call. </p>
-
-<p>To facilitate this, the passthrough function <code>.usingAuth()</code> allows you to pre-define the auth context of the next API call.</p>
-<pre class="highlight swift"><code><span class="c1">// assume Usergrid.authFallback = .None</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="nf">usingAuth</span><span class="p">(</span><span class="kt">Usergrid</span><span class="o">.</span><span class="n">appAuth</span><span class="o">!</span><span class="p">)</span><span class="o">.</span><span class="kt">POST</span><span class="p">(</span><span class="s">"roles/guest/permissions"</span><span class="p">,</span> <span class="nv">jsonBody</span><span class="p">:</span> <span class="p">[</span><span class="s">"permission"</span> <span class="p">:</span> <span class="s">"get,post,put,delete:/**"</span><span class="p">]</span> <span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// here we've temporarily used the client credentials to modify permissions</span>
- <span class="c1">// subsequent calls will not use this auth context</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#user_operations_and_convenience_methods' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='user_operations_and_convenience_methods'>User operations and convenience methods</h2>
-
-<p><code>UsergridUser</code> has a number of helper/convenience methods to make working with user entities more convenient. If you are <em>not</em> utilizing the <code>Usergrid</code> shared instance, you must pass an instance of <code>UsergridClient</code> as the first argument to any of these helper methods.</p>
-<a href='#create' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='create'>create()</h3>
-
-<p>Creating a new user:</p>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">user</span> <span class="o">=</span> <span class="kt">UsergridUser</span><span class="p">(</span><span class="nv">username</span><span class="p">:</span> <span class="s">"username"</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="s">"password"</span><span class="p">)</span>
-<span class="n">user</span><span class="o">.</span><span class="nf">create</span><span class="p">()</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// user has now been created and should have a valid uuid</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#login' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='login'>login()</h3>
-
-<p>A simpler means of retrieving a user-level token:</p>
-<pre class="highlight swift"><code><span class="n">user</span><span class="o">.</span><span class="nf">login</span><span class="p">(</span><span class="s">"username"</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="s">"password"</span><span class="p">)</span> <span class="p">{</span> <span class="n">auth</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">error</span> <span class="k">in</span>
- <span class="c1">// user is now logged in</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#logout' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='logout'>logout()</h3>
-
-<p>Logs out the selected user. You can also use this convenience method on <code>Usergrid.currentUser</code>.</p>
-<pre class="highlight swift"><code><span class="n">user</span><span class="o">.</span><span class="nf">logout</span><span class="p">()</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// user is now logged out</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#resetpassword' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='resetpassword'>resetPassword()</h3>
-
-<p>Resets the password for the selected user.</p>
-<pre class="highlight swift"><code><span class="n">user</span><span class="o">.</span><span class="nf">resetPassword</span><span class="p">(</span><span class="s">"oldPassword"</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span> <span class="s">"newPassword"</span><span class="p">)</span> <span class="p">{</span> <span class="n">error</span><span class="p">,</span> <span class="n">didSucceed</span> <span class="k">in</span>
- <span class="c1">// if it was done correctly, the new password will be changed</span>
- <span class="c1">// 'didSucceed' is a boolean value that indicates whether it was changed successfully</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#usergriduser_checkavailable' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='usergriduser_checkavailable'>UsergridUser.CheckAvailable()</h3>
-
-<p>This is a class (static) method that allows you to check whether a username or email address is available or not.</p>
-<pre class="highlight swift"><code><span class="kt">UsergridUser</span><span class="o">.</span><span class="nf">checkAvailable</span><span class="p">(</span><span class="s">"email"</span><span class="p">,</span> <span class="nv">username</span><span class="p">:</span> <span class="kc">nil</span><span class="p">)</span> <span class="p">{</span> <span class="n">error</span><span class="p">,</span> <span class="n">available</span> <span class="k">in</span>
- <span class="c1">// 'available' == whether an email already exists for a user</span>
-<span class="p">}</span>
-
-<span class="kt">UsergridUser</span><span class="o">.</span><span class="nf">checkAvailable</span><span class="p">(</span><span class="kc">nil</span><span class="p">,</span> <span class="nv">username</span><span class="p">:</span> <span class="s">"username"</span><span class="p">)</span> <span class="p">{</span> <span class="n">error</span><span class="p">,</span> <span class="n">available</span> <span class="k">in</span>
- <span class="c1">// 'available' == whether an username already exists for a user</span>
-<span class="p">}</span>
-
-<span class="kt">UsergridUser</span><span class="o">.</span><span class="nf">checkAvailable</span><span class="p">(</span><span class="s">"email"</span><span class="p">,</span> <span class="nv">username</span><span class="p">:</span> <span class="s">"username"</span><span class="p">)</span> <span class="p">{</span> <span class="n">error</span><span class="p">,</span> <span class="n">available</span> <span class="k">in</span>
- <span class="c1">// 'available' == whether an email or username already exist for a user</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#querying_and_filtering_data' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='querying_and_filtering_data'>Querying and filtering data</h2>
-<a href='#usergridquery_initialization' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='usergridquery_initialization'>UsergridQuery initialization</h3>
-
-<p>The <code>UsergridQuery</code> class allows you to build out complex query filters using the Usergrid <a href="http://docs.apigee.com/app-services/content/querying-your-data">query syntax</a>.</p>
-
-<p>The first parameter of the <code>UsergridQuery</code> builder pattern should be the collection (or type) you intend to query. You can either pass this as an argument, or as the first builder object:</p>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span>
-<span class="c1">// or</span>
-<span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">()</span><span class="o">.</span><span class="nf">collection</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span>
-</code></pre>
-
-<p>You then can layer on additional queries:</p>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span><span class="o">.</span><span class="nf">gt</span><span class="p">(</span><span class="s">"weight"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="mf">2.4</span><span class="p">)</span>
- <span class="o">.</span><span class="nf">contains</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="s">"bl*"</span><span class="p">)</span>
- <span class="o">.</span><span class="nf">not</span><span class="p">()</span>
- <span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"white"</span><span class="p">)</span>
- <span class="o">.</span><span class="nf">or</span><span class="p">()</span>
- <span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"orange"</span><span class="p">)</span>
-</code></pre>
-
-<p>You can also adjust the number of results returned:</p>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="s">"black"</span><span class="p">)</span>
- <span class="o">.</span><span class="nf">limit</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>
-
-<span class="c1">// returns a maximum of 100 entiteis</span>
-</code></pre>
-
-<p>And sort the results:</p>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="s">"black"</span><span class="p">)</span>
- <span class="o">.</span><span class="nf">limit</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>
- <span class="o">.</span><span class="nf">asc</span><span class="p">(</span><span class="s">"name"</span><span class="p">)</span>
-
-<span class="c1">// sorts by 'name', ascending</span>
-</code></pre>
-
-<p>And you can do geo-location queries:</p>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"devices"</span><span class="p">)</span><span class="o">.</span><span class="nf">locationWithin</span><span class="p">(</span><span class="o"><</span><span class="n">distance</span><span class="o">></span><span class="p">,</span> <span class="nv">latitude</span><span class="p">:</span> <span class="o"><</span><span class="n">lat</span><span class="o">></span><span class="p">,</span> <span class="nv">longitude</span><span class="p">:</span> <span class="o"><</span><span class="n">long</span><span class="o">></span><span class="p">)</span>
-</code></pre>
-<a href='#using_a_query_in_a_request' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='using_a_query_in_a_request'>Using a query in a request</h3>
-
-<p>Queries can be passed as parameters to GET, PUT, and DELETE requests:</p>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="kt">GET</span><span class="p">(</span><span class="s">"type"</span><span class="p">,</span> <span class="nv">query</span><span class="p">:</span> <span class="n">query</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// Gets entities of a given type matching the query.</span>
-<span class="p">}</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">PUT</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="nv">jsonBody</span><span class="p">:</span> <span class="p">[</span><span class="s">"aNewProperty"</span><span class="p">:</span><span class="s">"A new value"</span><span class="p">])</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// Updates the entities matching the query with the new property.</span>
-<span class="p">}</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">DELETE</span><span class="p">(</span><span class="n">query</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// Deletes entities of a given type matching the query.</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#list_of_query_builder_objects' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='list_of_query_builder_objects'>List of query builder objects</h3>
-
-<p><code>type("string")</code></p>
-
-<blockquote>
-<p>The collection name to query</p>
-</blockquote>
-
-<p><code>collection("string")</code></p>
-
-<blockquote>
-<p>An alias for <code>type</code></p>
-</blockquote>
-
-<p><code>eq("key", value: "value")</code> or
-<code>equals("key", value: "value")</code> or
-<code>filter("key", value: "value")</code> </p>
-
-<blockquote>
-<p>Equal to (e.g. <code>where color = 'black'</code>)</p>
-</blockquote>
-
-<p><code>contains("key", value: "value")</code> or
-<code>containsString("key", value: "value")</code> or
-<code>containsWord("key", value: "value")</code></p>
-
-<blockquote>
-<p>Contains a string (e.g.<code>where color contains 'bl*'</code>)</p>
-</blockquote>
-
-<p><code>gt("key", value: "value")</code> or
-<code>greaterThan("key", value: "value")</code></p>
-
-<blockquote>
-<p>Greater than (e.g. <code>where weight > 2.4</code>)</p>
-</blockquote>
-
-<p><code>gte("key", value: "value")</code> or
-<code>greaterThanOrEqual("key", value: "value")</code></p>
-
-<blockquote>
-<p>Greater than or equal to (e.g. <code>where weight >= 2.4</code>)</p>
-</blockquote>
-
-<p><code>lt("key", value: "value")</code> or <code>lessThan("key", value: "value")</code></p>
-
-<blockquote>
-<p>Less than (e.g. <code>where weight < 2.4</code>)</p>
-</blockquote>
-
-<p><code>lte("key", value: "value")</code> or <code>lessThanOrEqual("key", value: "value")</code></p>
-
-<blockquote>
-<p>Less than or equal to (e.g. <code>where weight <= 2.4</code>)</p>
-</blockquote>
-
-<p><code>not()</code></p>
-
-<blockquote>
-<p>Negates the next block in the builder pattern, e.g.:</p>
-</blockquote>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span><span class="o">.</span><span class="nf">not</span><span class="p">()</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="s">"black"</span><span class="p">)</span>
-<span class="c1">// select * from cats where not color = 'black'</span>
-</code></pre>
-
-<p><code>and()</code></p>
-
-<blockquote>
-<p>Joins two queries by requiring both of them. <code>and</code> is also implied when joining two queries <em>without</em> an operator. E.g.:</p>
-</blockquote>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"black"</span><span class="p">)</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"fur"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"longHair"</span><span class="p">)</span>
-<span class="c1">// is identical to:</span>
-<span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"black"</span><span class="p">)</span><span class="o">.</span><span class="nf">and</span><span class="p">()</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"fur"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span><span class="s">"longHair"</span><span class="p">)</span>
-</code></pre>
-
-<p><code>or()</code></p>
-
-<blockquote>
-<p>Joins two queries by requiring only one of them. <code>or</code> is never implied. e.g.:</p>
-</blockquote>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">(</span><span class="s">"cats"</span><span class="p">)</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span><span class="nv">value</span><span class="p">:</span> <span class="s">"black"</span><span class="p">)</span><span class="o">.</span><span class="nf">or</span><span class="p">()</span><span class="o">.</span><span class="nf">eq</span><span class="p">(</span><span class="s">"color"</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="s">"white"</span><span class="p">)</span>
-</code></pre>
-
-<blockquote>
-<p>When using <code>or()</code> and <code>and()</code> operators, <code>and()</code> joins will take precedence over <code>or()</code> joins. You can read more about query operators and precedence <a href="http://docs.apigee.com/api-baas/content/supported-query-operators-data-types">here</a>.</p>
-</blockquote>
-
-<p><code>locationWithin(distanceInMeters, latitude: latitude, longitude: longitude)</code></p>
-
-<blockquote>
-<p>Returns entities which have a location within the specified radius. Arguments can be <code>float</code> or <code>int</code>.</p>
-</blockquote>
-
-<p><code>asc("key")</code> or <code>ascending("key")</code></p>
-
-<blockquote>
-<p>Sorts the results by the specified property, ascending</p>
-</blockquote>
-
-<p><code>desc("key")</code> or <code>descending("key")</code></p>
-
-<blockquote>
-<p>Sorts the results by the specified property, descending</p>
-</blockquote>
-
-<p><code>sort("key", value: .Asc)</code></p>
-
-<blockquote>
-<p>Sorts the results by the specified property, in the specified <code>UsergridQuerySortOrder</code> (<code>.Asc</code> or <code>.Desc</code>).</p>
-</blockquote>
-
-<p><code>limit(int)</code></p>
-
-<blockquote>
-<p>The maximum number of entities to return</p>
-</blockquote>
-
-<p><code>cursor("string")</code></p>
-
-<blockquote>
-<p>A pagination cursor string</p>
-</blockquote>
-
-<p><code>fromString("query string")</code></p>
-
-<blockquote>
-<p>A special builder property that allows you to input a pre-defined query string. All builder properties will be ignored when this property is defined. For example:</p>
-</blockquote>
-<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">query</span> <span class="o">=</span> <span class="kt">UsergridQuery</span><span class="p">()</span><span class="o">.</span><span class="nf">fromString</span><span class="p">(</span><span class="s">"select * where color = 'black' order by name asc"</span><span class="p">)</span>
-</code></pre>
-<a href='#usergridresponse_object' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='usergridresponse_object'>UsergridResponse object</h2>
-
-<p><code>UsergridResponse</code> is the core class that handles both successful and unsuccessful HTTP responses from Usergrid. </p>
-
-<p>If a request is successful, any entities returned in the response will be automatically parsed into <code>UsergridEntity</code> objects and pushed to the <code>entities</code> property.</p>
-
-<p>If a request fails, the <code>error</code> property will contain information about the problem encountered.</p>
-<a href='#ok' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='ok'>ok</h3>
-
-<p>You can check <code>UsergridResponse.ok</code>, a <code>Bool</code> value, to see if the response was successful. Any status code <code>< 400</code> returns true.</p>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="kt">GET</span><span class="p">(</span><span class="s">"collection"</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">ok</span> <span class="p">{</span>
- <span class="c1">// woo!</span>
- <span class="p">}</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#entity_entities_user_users_first_last' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='entity_entities_user_users_first_last'>entity, entities, user, users, first, last</h3>
-
-<p>Depending on the call you make, any entities returned in the response will be automatically parsed into <code>UsergridEntity</code> objects and pushed to the <code>entities</code> property. If you’re querying the <code>users</code> collection, these will also be <code>UsergridUser</code> objects, a subclass of <code>UsergridEntity</code>.</p>
-
-<ul>
-<li><p><code>.first</code> returns the first entity in an array of entities; <code>.entity</code> is an alias to <code>.first</code>. If there are no entities, both of these will be undefined.</p></li>
-<li><p><code>.last</code> returns the last entity in an array of entities; if there is only one entity in the array, this will be the same as <code>.first</code> <em>and</em> <code>.entity</code>, and will be undefined if there are no entities in the response.</p></li>
-<li><p><code>.entities</code> will either be an array of entities in the response, or an empty array.</p></li>
-<li><p><code>.user</code> is a special alias for <code>.entity</code> for when querying the <code>users</code> collection. Instead of being a <code>UsergridEntity</code>, it will be its subclass, <code>UsergridUser</code>.</p></li>
-<li><p><code>.users</code> is the same as <code>.user</code>, though behaves as <code>.entities</code> does by returning either an array of UsergridUser objects or an empty array.</p></li>
-</ul>
-
-<p>Examples:</p>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="kt">GET</span><span class="p">(</span><span class="s">"collection"</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// you can access:</span>
- <span class="c1">// response.entities (the returned entities)</span>
- <span class="c1">// response.first (the first entity)</span>
- <span class="c1">// response.entity (same as response.first)</span>
- <span class="c1">// response.last (the last entity returned)</span>
-<span class="p">}</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">GET</span><span class="p">(</span><span class="s">"collection"</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span><span class="s">"<uuid-or-name>"</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// you can access:</span>
- <span class="c1">// response.entity (the returned entity) </span>
- <span class="c1">// response.entities (containing only the returned entity)</span>
- <span class="c1">// response.first (same as response.entity)</span>
- <span class="c1">// response.last (same as response.entity)</span>
-<span class="p">}</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">GET</span><span class="p">(</span><span class="s">"users"</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// you can access:</span>
- <span class="c1">// response.users (the returned users)</span>
- <span class="c1">// response.entities (same as response.users)</span>
- <span class="c1">// response.user (the first user) </span>
- <span class="c1">// response.entity (same as response.user) </span>
- <span class="c1">// response.first (same as response.user) </span>
- <span class="c1">// response.last (the last user)</span>
-<span class="p">}</span>
-
-<span class="kt">Usergrid</span><span class="o">.</span><span class="kt">GET</span><span class="p">(</span><span class="s">"users"</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span><span class="s">"<uuid-or-name>"</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// you can access;</span>
- <span class="c1">// response.users (containing only the one user)</span>
- <span class="c1">// response.entities (same as response.users)</span>
- <span class="c1">// response.user (the returned user) </span>
- <span class="c1">// response.entity (same as response.user) </span>
- <span class="c1">// response.first (same as response.user) </span>
- <span class="c1">// response.last (same as response.user) </span>
-<span class="p">}</span>
-</code></pre>
-<a href='#connections' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='connections'>Connections</h2>
-
-<p>Connections can be managed using <code>Usergrid.connect()</code>, <code>Usergrid.disconnect()</code>, and <code>Usergrid.getConnections()</code>, or entity convenience methods of the same name. </p>
-
-<p>When retrieving connections via <code>Usergrid.getConnections()</code>, you can pass in a optional <code>UsergridQuery</code> object in order to filter the connectioned entities returned.</p>
-<a href='#connect' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='connect'>Connect</h3>
-
-<p>Create a connection between two entities:</p>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="nf">connect</span><span class="p">(</span><span class="n">entity1</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span> <span class="s">"relationship"</span><span class="p">,</span> <span class="nv">to</span><span class="p">:</span> <span class="n">entity2</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// entity1 now has an outbound connection to entity2</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#retrieve_connections' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='retrieve_connections'>Retrieve Connections</h3>
-
-<p>Retrieve outbound connections:</p>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="nf">getConnections</span><span class="p">(</span><span class="o">.</span><span class="kt">Out</span><span class="p">,</span> <span class="nv">entity</span><span class="p">:</span> <span class="n">entity1</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span> <span class="s">"relationship"</span><span class="p">,</span> <span class="nv">query</span><span class="p">:</span> <span class="kc">nil</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// entities is an array of entities that entity1 is connected to via 'relationship'</span>
- <span class="c1">// in this case, we'll see entity2 in the array</span>
-<span class="p">}</span>
-</code></pre>
-
-<p>Retrieve inbound connections:</p>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="nf">getConnections</span><span class="p">(</span><span class="o">.</span><span class="kt">In</span><span class="p">,</span> <span class="nv">entity</span><span class="p">:</span> <span class="n">entity2</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span> <span class="s">"relationship"</span><span class="p">,</span> <span class="nv">query</span><span class="p">:</span> <span class="kc">nil</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// entities is an array of entities that connect to entity2 via 'relationship'</span>
- <span class="c1">// in this case, we'll see entity1 in the array</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#disconnect' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='disconnect'>Disconnect</h3>
-
-<p>Delete a connection between two entities:</p>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="nf">disconnect</span><span class="p">(</span><span class="n">entity1</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span> <span class="s">"relationship"</span><span class="p">,</span> <span class="nv">from</span><span class="p">:</span> <span class="n">entity2</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// entity1's outbound connection to entity2 has been destroyed</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#assets' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='assets'>Assets</h2>
-
-<p>Assets can be uploaded and downloaded either directly using <code>Usergrid.uploadAsset()</code> or <code>Usergrid.downloadAsset()</code>, or via <code>UsergridEntity</code> convenience methods with the same names. Before uploading an asset, you will need to initialize a <code>UsergridAsset</code> instance.</p>
-<a href='#initialization' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='initialization'>Initialization</h3>
-
-<p><em>Note: When initializing a <code>UsergridAsset</code> object specifying a file name is optional.</em></p>
-
-<ul>
-<li>Using NSData:</li>
-</ul>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">image</span> <span class="o">=</span> <span class="kt">UIImage</span><span class="p">(</span><span class="nv">contentsOfFile</span><span class="p">:</span> <span class="s">"path/to/image"</span><span class="p">)</span>
-<span class="k">let</span> <span class="nv">data</span> <span class="o">=</span> <span class="kt">UIImagePNGRepresentation</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
-<span class="k">let</span> <span class="nv">asset</span> <span class="o">=</span> <span class="kt">UsergridAsset</span><span class="p">(</span><span class="nv">fileName</span><span class="p">:</span><span class="s">"<file-name-or-nil>"</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="n">data</span><span class="o">!</span><span class="p">,</span> <span class="nv">contentType</span><span class="p">:</span><span class="s">"image/png"</span><span class="p">)</span>
-</code></pre>
-
-<ul>
-<li>Using an UIImage object:</li>
-</ul>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">image</span> <span class="o">=</span> <span class="kt">UIImage</span><span class="p">(</span><span class="nv">contentsOfFile</span><span class="p">:</span> <span class="s">"path/to/image"</span><span class="p">)</span>
-<span class="k">let</span> <span class="nv">asset</span> <span class="o">=</span> <span class="kt">UsergridAsset</span><span class="p">(</span><span class="nv">fileName</span><span class="p">:</span><span class="s">"<file-name-or-nil>"</span><span class="p">,</span> <span class="nv">image</span><span class="p">:</span> <span class="n">image</span><span class="o">!</span><span class="p">,</span> <span class="nv">imageContentType</span><span class="p">:</span> <span class="o">.</span><span class="kt">Png</span><span class="p">)</span>
-</code></pre>
-
-<ul>
-<li>Using a file URL:</li>
-</ul>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">fileUrl</span> <span class="o">=</span> <span class="kt">NSURL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="s">"local/path/to/file"</span><span class="p">)</span>
-<span class="k">if</span> <span class="n">fileUrl</span><span class="o">.</span><span class="nf">isFileReferenceURL</span><span class="p">()</span> <span class="p">{</span> <span class="c1">// This must be a file reference url.</span>
- <span class="k">let</span> <span class="nv">asset</span> <span class="o">=</span> <span class="kt">UsergridAsset</span><span class="p">(</span><span class="nv">fileName</span><span class="p">:</span><span class="s">"<file-name-or-nil>"</span><span class="p">,</span> <span class="nv">fileUrl</span><span class="p">:</span> <span class="n">fileUrl</span><span class="o">!</span><span class="p">,</span> <span class="nv">contentType</span><span class="p">:</span><span class="s">"<content-type>"</span><span class="p">)</span>
-<span class="p">}</span>
-</code></pre>
-<a href='#uploading' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='uploading'>Uploading</h3>
-
-<p>Upload an image and connect it to an entity:</p>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">image</span> <span class="o">=</span> <span class="kt">UIImage</span><span class="p">(</span><span class="nv">contentsOfFile</span><span class="p">:</span> <span class="s">"path/to/image"</span><span class="p">)</span>
-<span class="k">let</span> <span class="nv">asset</span> <span class="o">=</span> <span class="kt">UsergridAsset</span><span class="p">(</span><span class="nv">fileName</span><span class="p">:</span><span class="s">"<file-name-or-nil>"</span><span class="p">,</span> <span class="nv">image</span><span class="p">:</span> <span class="n">image</span><span class="o">!</span><span class="p">,</span> <span class="nv">imageContentType</span><span class="p">:</span> <span class="o">.</span><span class="kt">Png</span><span class="p">)</span><span class="o">!</span>
-<span class="kt">Usergrid</span><span class="o">.</span><span class="nf">uploadAsset</span><span class="p">(</span><span class="n">entity</span><span class="p">,</span>
- <span class="k">as</span><span class="nv">set</span><span class="p">:</span> <span class="k">asset</span><span class="p">,</span>
- <span class="nv">progress</span><span class="p">:</span> <span class="p">{</span> <span class="n">bytesFinished</span><span class="p">,</span> <span class="n">bytesExpected</span> <span class="k">in</span>
- <span class="c1">// Monitor the upload progress</span>
- <span class="p">},</span>
- <span class="nv">completion</span><span class="p">:</span> <span class="p">{</span> <span class="k">asset</span><span class="p">,</span> <span class="n">response</span> <span class="k">in</span>
- <span class="c1">// The asset is now uploaded to Usergrid and entity.asset == asset</span>
-<span class="p">})</span>
-</code></pre>
-<a href='#downloading' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h3 id='downloading'>Downloading</h3>
-
-<p>Download an image which is connected to an entity:</p>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="nf">downloadAsset</span><span class="p">(</span><span class="n">entity</span><span class="p">,</span>
- <span class="nv">contentType</span><span class="p">:</span> <span class="s">"<expected-content-type>"</span><span class="p">,</span>
- <span class="nv">progress</span><span class="p">:</span> <span class="p">{</span> <span class="n">bytesFinished</span><span class="p">,</span> <span class="n">bytesExpected</span> <span class="k">in</span>
- <span class="c1">// Monitor the download progress</span>
- <span class="p">},</span>
- <span class="nv">completion</span><span class="p">:{</span> <span class="k">asset</span><span class="p">,</span> <span class="n">error</span> <span class="k">in</span>
- <span class="c1">// The asset is now downloaded from Usergrid and entity.asset == asset</span>
-<span class="p">})</span>
-</code></pre>
-<a href='#custom_usergridentity_subclasses' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='custom_usergridentity_subclasses'>Custom UsergridEntity Subclasses</h2>
-
-<p>Creating custom subclasses of the base <code>UsergridEntity</code> class (just like <code>UsergridUser</code> and <code>UsergridDevice</code>) is possible.</p>
-
-<blockquote>
-<p>For a working example of creating a custom subclass refer to the ActivityFeed sample app located in the <code>/Samples</code> folder. The custom subclass there is named <code>ActivityEntity</code>.</p>
-</blockquote>
-
-<ul>
-<li>To do so, subclass <code>UsergridEntity</code> and implement the required methods:</li>
-</ul>
-<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">UsergridSDK</span>
-
-<span class="kd">public</span> <span class="kd">class</span> <span class="kt">ActivityEntity</span><span class="p">:</span> <span class="kt">UsergridEntity</span> <span class="p">{</span>
-
- <span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">propertyDict</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="p">{</span>
- <span class="k">super</span><span class="o">.</span><span class="nf">init</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="n">type</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="n">name</span><span class="p">,</span> <span class="nv">propertyDict</span><span class="p">:</span> <span class="n">propertyDict</span><span class="p">)</span>
- <span class="p">}</span>
-
- <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> <span class="p">{</span>
- <span class="k">super</span><span class="o">.</span><span class="nf">init</span><span class="p">(</span><span class="nv">coder</span><span class="p">:</span> <span class="n">aDecoder</span><span class="p">)</span>
- <span class="p">}</span>
-<span class="p">}</span>
-</code></pre>
-
-<ul>
-<li>You will also need to register the custom subclass:</li>
-</ul>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="nf">initSharedInstance</span><span class="p">(</span><span class="nv">orgId</span><span class="p">:</span> <span class="s">"orgId"</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="s">"appId"</span><span class="p">)</span>
-<span class="kt">UsergridEntity</span><span class="o">.</span><span class="nf">mapCustomType</span><span class="p">(</span><span class="s">"activity"</span><span class="p">,</span> <span class="nv">toSubclass</span><span class="p">:</span> <span class="kt">ActivityEntity</span><span class="o">.</span><span class="k">self</span><span class="p">)</span>
-</code></pre>
-
-<p>By registering your custom subclass, the <code>UsergridEntity</code> and <code>UsergridResponse</code> classes are able to generate instances of these classes based on the an entities <code>type</code>.</p>
-
-<p>In the above example, entities which have a <code>type</code> value of <code>activity</code> can now be cast as <code>ActivityEntity</code> objects. e.g.:</p>
-<pre class="highlight swift"><code><span class="kt">Usergrid</span><span class="o">.</span><span class="kt">GET</span><span class="p">(</span><span class="s">"activity"</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
- <span class="k">var</span> <span class="nv">activityEntities</span><span class="p">:</span> <span class="p">[</span><span class="kt">ActivityEntity</span><span class="p">]?</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">entities</span> <span class="k">as?</span> <span class="p">[</span><span class="kt">ActivityEntity</span><span class="p">]</span>
-<span class="p">}</span>
-</code></pre>
-
- </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/js/jazzy.js
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/js/jazzy.js b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/js/jazzy.js
deleted file mode 100755
index 4ff9455..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/js/jazzy.js
+++ /dev/null
@@ -1,40 +0,0 @@
-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
-}
-
-// On doc load, toggle the URL hash discussion if present
-$(document).ready(function() {
- if (!window.jazzy.docset) {
- var linkToHash = $('a[href="' + window.location.hash +'"]');
- linkToHash.trigger("click");
- }
-});
-
-// On token click, toggle its discussion and animate token.marginLeft
-$(".token").click(function(event) {
- if (window.jazzy.docset) {
- return;
- }
- var link = $(this);
- var animationDuration = 300;
- var tokenOffset = "15px";
- var original = link.css('marginLeft') == tokenOffset;
- link.animate({'margin-left':original ? "0px" : tokenOffset}, animationDuration);
- $content = link.parent().parent().next();
- $content.slideToggle(animationDuration);
-
- // Keeps the document from jumping to the hash.
- var href = $(this).attr('href');
- if (history.pushState) {
- history.pushState({}, '', href);
- } else {
- location.hash = href;
- }
- event.preventDefault();
-});
[29/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Enums/UsergridQueryOperator.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridQueryOperator.html b/sdks/swift/docs/Enums/UsergridQueryOperator.html
deleted file mode 100644
index fc07091..0000000
--- a/sdks/swift/docs/Enums/UsergridQueryOperator.html
+++ /dev/null
@@ -1,431 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridQueryOperator Enum 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/Enum/UsergridQueryOperator" class="dashAnchor"></a>
- <a title="UsergridQueryOperator Enum 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" />
- UsergridQueryOperator Enum 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>UsergridQueryOperator</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridQueryOperator</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code><a href="../Classes/UsergridQuery.html">UsergridQuery</a></code> specific operators.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK21UsergridQueryOperator5EqualFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Equal" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK21UsergridQueryOperator5EqualFMS0_S0_">Equal</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>’=’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Equal</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK21UsergridQueryOperator11GreaterThanFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/GreaterThan" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK21UsergridQueryOperator11GreaterThanFMS0_S0_">GreaterThan</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>’>’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">GreaterThan</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK21UsergridQueryOperator18GreaterThanEqualToFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/GreaterThanEqualTo" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK21UsergridQueryOperator18GreaterThanEqualToFMS0_S0_">GreaterThanEqualTo</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>’>=’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">GreaterThanEqualTo</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK21UsergridQueryOperator8LessThanFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/LessThan" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK21UsergridQueryOperator8LessThanFMS0_S0_">LessThan</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>’<’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">LessThan</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK21UsergridQueryOperator15LessThanEqualToFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/LessThanEqualTo" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK21UsergridQueryOperator15LessThanEqualToFMS0_S0_">LessThanEqualTo</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>’<=’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">LessThanEqualTo</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFO11UsergridSDK21UsergridQueryOperator10fromStringFSSGSqS0__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFO11UsergridSDK21UsergridQueryOperator10fromStringFSSGSqS0__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets the corresponding <code><a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a></code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridQueryOperator</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stringValue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The string value to convert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The corresponding <code><a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a></code> or nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK21UsergridQueryOperator11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK21UsergridQueryOperator11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Enums/UsergridQuerySortOrder.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridQuerySortOrder.html b/sdks/swift/docs/Enums/UsergridQuerySortOrder.html
deleted file mode 100644
index 3758d3f..0000000
--- a/sdks/swift/docs/Enums/UsergridQuerySortOrder.html
+++ /dev/null
@@ -1,338 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridQuerySortOrder Enum 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/Enum/UsergridQuerySortOrder" class="dashAnchor"></a>
- <a title="UsergridQuerySortOrder Enum 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" />
- UsergridQuerySortOrder Enum 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>UsergridQuerySortOrder</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridQuerySortOrder</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code><a href="../Classes/UsergridQuery.html">UsergridQuery</a></code> specific sort orders.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridQuerySortOrder3AscFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Asc" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridQuerySortOrder3AscFMS0_S0_">Asc</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort order is ascending.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Asc</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridQuerySortOrder4DescFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Desc" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridQuerySortOrder4DescFMS0_S0_">Desc</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sort order is descending.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Desc</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFO11UsergridSDK22UsergridQuerySortOrder10fromStringFSSGSqS0__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFO11UsergridSDK22UsergridQuerySortOrder10fromStringFSSGSqS0__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets the corresponding <code><a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a></code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridQuerySortOrder</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stringValue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The string value to convert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The corresponding <code><a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a></code> or nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK22UsergridQuerySortOrder11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK22UsergridQuerySortOrder11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Enums/UsergridUserProperties.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridUserProperties.html b/sdks/swift/docs/Enums/UsergridUserProperties.html
deleted file mode 100644
index eff2cdc..0000000
--- a/sdks/swift/docs/Enums/UsergridUserProperties.html
+++ /dev/null
@@ -1,524 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridUserProperties Enum 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/Enum/UsergridUserProperties" class="dashAnchor"></a>
- <a title="UsergridUserProperties Enum 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" />
- UsergridUserProperties Enum 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>UsergridUserProperties</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridUserProperties</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> specific properties keys.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties4NameFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Name" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties4NameFMS0_S0_">Name</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘name’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Name</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties8UsernameFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Username" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties8UsernameFMS0_S0_">Username</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘username’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Username</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties8PasswordFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Password" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties8PasswordFMS0_S0_">Password</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘password’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Password</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties5EmailFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Email" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties5EmailFMS0_S0_">Email</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘email’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Email</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties3AgeFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Age" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties3AgeFMS0_S0_">Age</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘age’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Age</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties9ActivatedFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Activated" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties9ActivatedFMS0_S0_">Activated</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘activated’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Activated</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties8DisabledFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Disabled" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties8DisabledFMS0_S0_">Disabled</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘disabled’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Disabled</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK22UsergridUserProperties7PictureFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Picture" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK22UsergridUserProperties7PictureFMS0_S0_">Picture</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘picture’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Picture</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFO11UsergridSDK22UsergridUserProperties10fromStringFSSGSqS0__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFO11UsergridSDK22UsergridUserProperties10fromStringFSSGSqS0__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets the corresponding <code><a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a></code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridUserProperties</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stringValue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The string value to convert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The corresponding <code><a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a></code> or nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK22UsergridUserProperties11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK22UsergridUserProperties11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Extensions.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Extensions.html b/sdks/swift/docs/Extensions.html
deleted file mode 100644
index a5c3fb5..0000000
--- a/sdks/swift/docs/Extensions.html
+++ /dev/null
@@ -1,203 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Extensions 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 title="Extensions 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" />
- Extensions 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>Extensions</h1>
- <p>The following extensions are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/c:objc(cs)NSDate"></a>
- <a name="//apple_ref/swift/Extension/NSDate" class="dashAnchor"></a>
- <a class="token" href="#/c:objc(cs)NSDate">NSDate</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- <a href="Extensions/NSDate.html" class="slightly-smaller">See more</a>
- </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>
[41/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridAppAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridAppAuth.html b/sdks/swift/docs/Classes/UsergridAppAuth.html
deleted file mode 100644
index 70c940e..0000000
--- a/sdks/swift/docs/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/Classes/UsergridAsset.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridAsset.html b/sdks/swift/docs/Classes/UsergridAsset.html
deleted file mode 100644
index 568d727..0000000
--- a/sdks/swift/docs/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/Classes/UsergridAssetUploadRequest.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridAssetUploadRequest.html b/sdks/swift/docs/Classes/UsergridAssetUploadRequest.html
deleted file mode 100644
index f7a0b00..0000000
--- a/sdks/swift/docs/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>
[08/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Global Variables.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Global Variables.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Global Variables.html
deleted file mode 100644
index 2685313..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Global Variables.html
+++ /dev/null
@@ -1,210 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Global Variables 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 title="Global Variables 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" />
- Global Variables 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>Global Variables</h1>
- <p>The following global variables are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:v11UsergridSDK18UsergridSDKVersionSS"></a>
- <a name="//apple_ref/swift/Global/UsergridSDKVersion" class="dashAnchor"></a>
- <a class="token" href="#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The version number for the Usergrid Swift SDK.</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">UsergridSDKVersion</span> <span class="o">=</span> <span class="s">"2.1.1"</span></code></pre>
-
- </div>
- </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/Protocols.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html
deleted file mode 100644
index 7e9f435..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html
+++ /dev/null
@@ -1,146 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Protocols 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 title="Protocols Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="index.html"> Docs</a> (46% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="index.html"> Reference</a>
- <img id="carat" src="img/carat.png" />
- Protocols 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/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/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/UsergridResponse.html">UsergridResponse</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="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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="Extensions/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="Protocols/UsergridAuth.html">UsergridAuth</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>Protocols</h1>
- <p>The following protocols are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:P11UsergridSDK12UsergridAuth"></a>
- <a name="//apple_ref/swift/Protocol/UsergridAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:P11UsergridSDK12UsergridAuth">UsergridAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- <a href="Protocols/UsergridAuth.html" class="slightly-smaller">See more</a>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-21)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/Protocols/UsergridAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Protocols/UsergridAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Protocols/UsergridAuth.html
deleted file mode 100644
index dfaaf0d..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Protocols/UsergridAuth.html
+++ /dev/null
@@ -1,260 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuth Protocol 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/Protocol/UsergridAuth" class="dashAnchor"></a>
- <a title="UsergridAuth Protocol Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html"> Docs</a> (46% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> Reference</a>
- <img id="carat" src="../img/carat.png" />
- UsergridAuth Protocol 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/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/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/UsergridResponse.html">UsergridResponse</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="../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="../Extensions/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Protocols/UsergridAuth.html">UsergridAuth</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridAuth</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth11accessTokenGSqSS_"></a>
- <a name="//apple_ref/swift/Property/accessToken" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth9expiresInGSqSi_"></a>
- <a name="//apple_ref/swift/Property/expiresIn" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth9expiresInGSqSi_">expiresIn</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth8hasTokenSb"></a>
- <a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth8hasTokenSb">hasToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth12tokenIsValidSb"></a>
- <a name="//apple_ref/swift/Property/tokenIsValid" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth12tokenIsValidSb">tokenIsValid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth9isExpiredSb"></a>
- <a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth9isExpiredSb">isExpired</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vP11UsergridSDK12UsergridAuth12jsonBodyDictGVSs10DictionarySSPSs9AnyObject__"></a>
- <a name="//apple_ref/swift/Property/jsonBodyDict" class="dashAnchor"></a>
- <a class="token" href="#/s:vP11UsergridSDK12UsergridAuth12jsonBodyDictGVSs10DictionarySSPSs9AnyObject__">jsonBodyDict</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FP11UsergridSDK12UsergridAuth16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest"></a>
- <a name="//apple_ref/swift/Method/buildAuthRequest(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FP11UsergridSDK12UsergridAuth16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest">buildAuthRequest(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-21)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/Typealiases.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Typealiases.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Typealiases.html
deleted file mode 100644
index 4a5b04a..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Typealiases.html
+++ /dev/null
@@ -1,411 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Typealiases 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 title="Typealiases 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" />
- Typealiases 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>Typealiases</h1>
- <p>The following typealiases are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK30UsergridAppAuthCompletionBlock"></a>
- <a name="//apple_ref/swift/Alias/UsergridAppAuthCompletionBlock" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used in <code><a href="Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> authentication methods.</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">typealias</span> <span class="kt">UsergridAppAuthCompletionBlock</span> <span class="o">=</span> <span class="p">(</span><span class="nv">auth</span><span class="p">:</span><span class="kt">UsergridAppAuth</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK31UsergridUserAuthCompletionBlock"></a>
- <a name="//apple_ref/swift/Alias/UsergridUserAuthCompletionBlock" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used in <code><a href="Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> authentication methods.</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">typealias</span> <span class="kt">UsergridUserAuthCompletionBlock</span> <span class="o">=</span> <span class="p">(</span><span class="nv">auth</span><span class="p">:</span><span class="kt">UsergridUserAuth</span><span class="p">?,</span> <span class="nv">user</span><span class="p">:</span><span class="kt">UsergridUser</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK34UsergridUserAvailabilityCompletion"></a>
- <a name="//apple_ref/swift/Alias/UsergridUserAvailabilityCompletion" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used for checking email and/or username availablity for new <code><a href="Classes/UsergridUser.html">UsergridUser</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="kd">typealias</span> <span class="kt">UsergridUserAvailabilityCompletion</span> <span class="o">=</span> <span class="p">(</span><span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?,</span> <span class="nv">available</span><span class="p">:</span><span class="kt">Bool</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK35UsergridUserResetPasswordCompletion"></a>
- <a name="//apple_ref/swift/Alias/UsergridUserResetPasswordCompletion" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used for changing the password of <code><a href="Classes/UsergridUser.html">UsergridUser</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="kd">typealias</span> <span class="kt">UsergridUserResetPasswordCompletion</span> <span class="o">=</span> <span class="p">(</span><span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?,</span> <span class="nv">didSucceed</span><span class="p">:</span><span class="kt">Bool</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK26UsergridResponseCompletion"></a>
- <a name="//apple_ref/swift/Alias/UsergridResponseCompletion" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used in for most <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> requests.</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">typealias</span> <span class="kt">UsergridResponseCompletion</span> <span class="o">=</span> <span class="p">(</span><span class="nv">response</span><span class="p">:</span> <span class="kt">UsergridResponse</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK28UsergridAssetRequestProgress"></a>
- <a name="//apple_ref/swift/Alias/UsergridAssetRequestProgress" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The progress block used in <code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> are being uploaded or downloaded.</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">typealias</span> <span class="kt">UsergridAssetRequestProgress</span> <span class="o">=</span> <span class="p">(</span><span class="nv">bytesFinished</span><span class="p">:</span><span class="kt">Int64</span><span class="p">,</span> <span class="nv">bytesExpected</span><span class="p">:</span> <span class="kt">Int64</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK29UsergridAssetUploadCompletion"></a>
- <a name="//apple_ref/swift/Alias/UsergridAssetUploadCompletion" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used in <code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> are finished 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="kd">typealias</span> <span class="kt">UsergridAssetUploadCompletion</span> <span class="o">=</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> <span class="nv">response</span><span class="p">:</span> <span class="kt">UsergridResponse</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:11UsergridSDK31UsergridAssetDownloadCompletion"></a>
- <a name="//apple_ref/swift/Alias/UsergridAssetDownloadCompletion" class="dashAnchor"></a>
- <a class="token" href="#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The completion block used in <code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> are finished downloading.</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">typealias</span> <span class="kt">UsergridAssetDownloadCompletion</span> <span class="o">=</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> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
-
- </div>
- </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/css/highlight.css
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/css/highlight.css b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/css/highlight.css
deleted file mode 100644
index d0db0e1..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/css/highlight.css
+++ /dev/null
@@ -1,200 +0,0 @@
-/* Credit to https://gist.github.com/wataru420/2048287 */
-.highlight {
- /* Comment */
- /* Error */
- /* Keyword */
- /* Operator */
- /* Comment.Multiline */
- /* Comment.Preproc */
- /* Comment.Single */
- /* Comment.Special */
- /* Generic.Deleted */
- /* Generic.Deleted.Specific */
- /* Generic.Emph */
- /* Generic.Error */
- /* Generic.Heading */
- /* Generic.Inserted */
- /* Generic.Inserted.Specific */
- /* Generic.Output */
- /* Generic.Prompt */
- /* Generic.Strong */
- /* Generic.Subheading */
- /* Generic.Traceback */
- /* Keyword.Constant */
- /* Keyword.Declaration */
- /* Keyword.Pseudo */
- /* Keyword.Reserved */
- /* Keyword.Type */
- /* Literal.Number */
- /* Literal.String */
- /* Name.Attribute */
- /* Name.Builtin */
- /* Name.Class */
- /* Name.Constant */
- /* Name.Entity */
- /* Name.Exception */
- /* Name.Function */
- /* Name.Namespace */
- /* Name.Tag */
- /* Name.Variable */
- /* Operator.Word */
- /* Text.Whitespace */
- /* Literal.Number.Float */
- /* Literal.Number.Hex */
- /* Literal.Number.Integer */
- /* Literal.Number.Oct */
- /* Literal.String.Backtick */
- /* Literal.String.Char */
- /* Literal.String.Doc */
- /* Literal.String.Double */
- /* Literal.String.Escape */
- /* Literal.String.Heredoc */
- /* Literal.String.Interpol */
- /* Literal.String.Other */
- /* Literal.String.Regex */
- /* Literal.String.Single */
- /* Literal.String.Symbol */
- /* Name.Builtin.Pseudo */
- /* Name.Variable.Class */
- /* Name.Variable.Global */
- /* Name.Variable.Instance */
- /* Literal.Number.Integer.Long */ }
- .highlight .c {
- color: #999988;
- font-style: italic; }
- .highlight .err {
- color: #a61717;
- background-color: #e3d2d2; }
- .highlight .k {
- color: #000000;
- font-weight: bold; }
- .highlight .o {
- color: #000000;
- font-weight: bold; }
- .highlight .cm {
- color: #999988;
- font-style: italic; }
- .highlight .cp {
- color: #999999;
- font-weight: bold; }
- .highlight .c1 {
- color: #999988;
- font-style: italic; }
- .highlight .cs {
- color: #999999;
- font-weight: bold;
- font-style: italic; }
- .highlight .gd {
- color: #000000;
- background-color: #ffdddd; }
- .highlight .gd .x {
- color: #000000;
- background-color: #ffaaaa; }
- .highlight .ge {
- color: #000000;
- font-style: italic; }
- .highlight .gr {
- color: #aa0000; }
- .highlight .gh {
- color: #999999; }
- .highlight .gi {
- color: #000000;
- background-color: #ddffdd; }
- .highlight .gi .x {
- color: #000000;
- background-color: #aaffaa; }
- .highlight .go {
- color: #888888; }
- .highlight .gp {
- color: #555555; }
- .highlight .gs {
- font-weight: bold; }
- .highlight .gu {
- color: #aaaaaa; }
- .highlight .gt {
- color: #aa0000; }
- .highlight .kc {
- color: #000000;
- font-weight: bold; }
- .highlight .kd {
- color: #000000;
- font-weight: bold; }
- .highlight .kp {
- color: #000000;
- font-weight: bold; }
- .highlight .kr {
- color: #000000;
- font-weight: bold; }
- .highlight .kt {
- color: #445588; }
- .highlight .m {
- color: #009999; }
- .highlight .s {
- color: #d14; }
- .highlight .na {
- color: #008080; }
- .highlight .nb {
- color: #0086B3; }
- .highlight .nc {
- color: #445588;
- font-weight: bold; }
- .highlight .no {
- color: #008080; }
- .highlight .ni {
- color: #800080; }
- .highlight .ne {
- color: #990000;
- font-weight: bold; }
- .highlight .nf {
- color: #990000; }
- .highlight .nn {
- color: #555555; }
- .highlight .nt {
- color: #000080; }
- .highlight .nv {
- color: #008080; }
- .highlight .ow {
- color: #000000;
- font-weight: bold; }
- .highlight .w {
- color: #bbbbbb; }
- .highlight .mf {
- color: #009999; }
- .highlight .mh {
- color: #009999; }
- .highlight .mi {
- color: #009999; }
- .highlight .mo {
- color: #009999; }
- .highlight .sb {
- color: #d14; }
- .highlight .sc {
- color: #d14; }
- .highlight .sd {
- color: #d14; }
- .highlight .s2 {
- color: #d14; }
- .highlight .se {
- color: #d14; }
- .highlight .sh {
- color: #d14; }
- .highlight .si {
- color: #d14; }
- .highlight .sx {
- color: #d14; }
- .highlight .sr {
- color: #009926; }
- .highlight .s1 {
- color: #d14; }
- .highlight .ss {
- color: #990073; }
- .highlight .bp {
- color: #999999; }
- .highlight .vc {
- color: #008080; }
- .highlight .vg {
- color: #008080; }
- .highlight .vi {
- color: #008080; }
- .highlight .il {
- color: #009999; }
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/css/jazzy.css
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/css/jazzy.css b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/css/jazzy.css
deleted file mode 100644
index 2a7da3a..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/css/jazzy.css
+++ /dev/null
@@ -1,331 +0,0 @@
-html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
- background: transparent;
- border: 0;
- margin: 0;
- outline: 0;
- padding: 0;
- vertical-align: baseline; }
-
-body {
- background-color: #f2f2f2;
- font-family: Helvetica, freesans, Arial, sans-serif;
- font-size: 14px;
- -webkit-font-smoothing: subpixel-antialiased;
- word-wrap: break-word; }
-
-h1, h2, h3 {
- margin-top: 0.8em;
- margin-bottom: 0.3em;
- font-weight: 100;
- color: black; }
-
-h1 {
- font-size: 2.5em; }
-
-h2 {
- font-size: 2em;
- border-bottom: 1px solid #e2e2e2; }
-
-h4 {
- font-size: 13px;
- line-height: 1.5;
- margin-top: 21px; }
-
-h5 {
- font-size: 1.1em; }
-
-h6 {
- font-size: 1.1em;
- color: #777; }
-
-.section-name {
- color: gray;
- display: block;
- font-family: Helvetica;
- font-size: 22px;
- font-weight: 100;
- margin-bottom: 15px; }
-
-pre, code {
- font: 0.95em Menlo, monospace;
- color: #777;
- word-wrap: normal; }
-
-p code, li code {
- background-color: #eee;
- padding: 2px 4px;
- border-radius: 4px; }
-
-a {
- color: #0088cc;
- text-decoration: none; }
-
-ul {
- padding-left: 15px; }
-
-li {
- line-height: 1.8em; }
-
-img {
- max-width: 100%; }
-
-blockquote {
- margin-left: 0;
- padding: 0 10px;
- border-left: 4px solid #ccc; }
-
-.content-wrapper {
- margin: 0 auto;
- width: 980px; }
-
-header {
- font-size: 0.85em;
- line-height: 26px;
- background-color: #414141;
- position: fixed;
- width: 100%;
- z-index: 1; }
- header img {
- padding-right: 6px;
- vertical-align: -4px;
- height: 16px; }
- header a {
- color: #fff; }
- header p {
- float: left;
- color: #999; }
- header .header-right {
- float: right;
- margin-left: 16px; }
-
-#breadcrumbs {
- background-color: #f2f2f2;
- height: 27px;
- padding-top: 17px;
- position: fixed;
- width: 100%;
- z-index: 1;
- margin-top: 26px; }
- #breadcrumbs #carat {
- height: 10px;
- margin: 0 5px; }
-
-.sidebar {
- background-color: #f9f9f9;
- border: 1px solid #e2e2e2;
- overflow-y: auto;
- overflow-x: hidden;
- position: fixed;
- top: 70px;
- bottom: 0;
- width: 230px;
- word-wrap: normal; }
-
-.nav-groups {
- list-style-type: none;
- background: #fff;
- padding-left: 0; }
-
-.nav-group-name {
- border-bottom: 1px solid #e2e2e2;
- font-size: 1.1em;
- font-weight: 100;
- padding: 15px 0 15px 20px; }
- .nav-group-name > a {
- color: #333; }
-
-.nav-group-tasks {
- margin-top: 5px; }
-
-.nav-group-task {
- font-size: 0.9em;
- list-style-type: none; }
- .nav-group-task a {
- color: #888; }
-
-.main-content {
- background-color: #fff;
- border: 1px solid #e2e2e2;
- margin-left: 246px;
- position: absolute;
- overflow: hidden;
- padding-bottom: 60px;
- top: 70px;
- width: 734px; }
- .main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote {
- margin-bottom: 1em; }
- .main-content p {
- line-height: 1.8em; }
- .main-content section .section:first-child {
- margin-top: 0;
- padding-top: 0; }
- .main-content section .task-group-section .task-group:first-of-type {
- padding-top: 10px; }
- .main-content section .task-group-section .task-group:first-of-type .section-name {
- padding-top: 15px; }
-
-.section {
- padding: 0 25px; }
-
-.highlight {
- background-color: #eee;
- padding: 10px 12px;
- border: 1px solid #e2e2e2;
- border-radius: 4px;
- overflow-x: auto; }
-
-.declaration .highlight {
- overflow-x: initial;
- padding: 0 40px 40px 0;
- margin-bottom: -25px;
- background-color: transparent;
- border: none; }
-
-.section-name {
- margin: 0;
- margin-left: 18px; }
-
-.task-group-section {
- padding-left: 6px;
- border-top: 1px solid #e2e2e2; }
-
-.task-group {
- padding-top: 0px; }
-
-.task-name-container a[name]:before {
- content: "";
- display: block;
- padding-top: 70px;
- margin: -70px 0 0; }
-
-.item {
- padding-top: 8px;
- width: 100%;
- list-style-type: none; }
- .item a[name]:before {
- content: "";
- display: block;
- padding-top: 70px;
- margin: -70px 0 0; }
- .item code {
- background-color: transparent;
- padding: 0; }
- .item .token {
- padding-left: 3px;
- margin-left: 15px;
- font-size: 11.9px; }
- .item .declaration-note {
- font-size: .85em;
- color: gray;
- font-style: italic; }
-
-.pointer-container {
- border-bottom: 1px solid #e2e2e2;
- left: -23px;
- padding-bottom: 13px;
- position: relative;
- width: 110%; }
-
-.pointer {
- background: #f9f9f9;
- border-left: 1px solid #e2e2e2;
- border-top: 1px solid #e2e2e2;
- height: 12px;
- left: 21px;
- top: -7px;
- -webkit-transform: rotate(45deg);
- -moz-transform: rotate(45deg);
- -o-transform: rotate(45deg);
- transform: rotate(45deg);
- position: absolute;
- width: 12px; }
-
-.height-container {
- display: none;
- left: -25px;
- padding: 0 25px;
- position: relative;
- width: 100%;
- overflow: hidden; }
- .height-container .section {
- background: #f9f9f9;
- border-bottom: 1px solid #e2e2e2;
- left: -25px;
- position: relative;
- width: 100%;
- padding-top: 10px;
- padding-bottom: 5px; }
-
-.aside, .language {
- padding: 6px 12px;
- margin: 12px 0;
- border-left: 5px solid #dddddd;
- overflow-y: hidden; }
- .aside .aside-title, .language .aside-title {
- font-size: 9px;
- letter-spacing: 2px;
- text-transform: uppercase;
- padding-bottom: 0;
- margin: 0;
- color: #aaa;
- -webkit-user-select: none; }
- .aside p:last-child, .language p:last-child {
- margin-bottom: 0; }
-
-.language {
- border-left: 5px solid #cde9f4; }
- .language .aside-title {
- color: #4b8afb; }
-
-.aside-warning {
- border-left: 5px solid #ff6666; }
- .aside-warning .aside-title {
- color: #ff0000; }
-
-.graybox {
- border-collapse: collapse;
- width: 100%; }
- .graybox p {
- margin: 0;
- word-break: break-word;
- min-width: 50px; }
- .graybox td {
- border: 1px solid #e2e2e2;
- padding: 5px 25px 5px 10px;
- vertical-align: middle; }
- .graybox tr td:first-of-type {
- text-align: right;
- padding: 7px;
- vertical-align: top;
- word-break: normal;
- width: 40px; }
-
-.slightly-smaller {
- font-size: 0.9em; }
-
-#footer {
- position: absolute;
- bottom: 10px;
- margin-left: 25px; }
- #footer p {
- margin: 0;
- color: #aaa;
- font-size: 0.8em; }
-
-html.dash header, html.dash #breadcrumbs, html.dash .sidebar {
- display: none; }
-html.dash .main-content {
- width: 980px;
- margin-left: 0;
- border: none;
- width: 100%;
- top: 0;
- padding-bottom: 0; }
-html.dash .height-container {
- display: block; }
-html.dash .item .token {
- margin-left: 0; }
-html.dash .content-wrapper {
- width: auto; }
-html.dash #footer {
- position: static; }
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/carat.png
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/carat.png b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/carat.png
deleted file mode 100755
index 29d2f7f..0000000
Binary files a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/carat.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/dash.png
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/dash.png b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/dash.png
deleted file mode 100755
index 6f694c7..0000000
Binary files a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/dash.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/gh.png
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/gh.png b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/gh.png
deleted file mode 100755
index 628da97..0000000
Binary files a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/img/gh.png and /dev/null differ
[45/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/UsergridUser.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridUser.swift b/sdks/swift/Source/UsergridUser.swift
deleted file mode 100644
index 17415ba..0000000
--- a/sdks/swift/Source/UsergridUser.swift
+++ /dev/null
@@ -1,523 +0,0 @@
-//
-// User.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 7/21/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-
-/// The completion block used for checking email and/or username availablity for new `UsergridUser` objects.
-public typealias UsergridUserAvailabilityCompletion = (error: UsergridResponseError?, available:Bool) -> Void
-
-/// The completion block used for changing the password of `UsergridUser` objects.
-public typealias UsergridUserResetPasswordCompletion = (error: UsergridResponseError?, didSucceed:Bool) -> Void
-
-/**
-`UsergridUser` is a special subclass of `UsergridEntity` that supports functions and properties unique to users.
-*/
-public class UsergridUser : UsergridEntity {
-
- static let USER_ENTITY_TYPE = "user"
-
- // MARK: - Instance Properties -
-
- /// The `UsergridUserAuth` object if this user was authenticated.
- public var auth: UsergridUserAuth?
-
- /**
- Property helper method for the `UsergridUser` objects `UsergridUserProperties.Name`.
-
- Unlike `UsergridEntity` objects, `UsergridUser`'s can change their name property which is why we provide a getter here.
- */
- override public var name: String? {
- set(name) { self[UsergridUserProperties.Name.stringValue] = name }
- get{ return super.name }
- }
-
- /// Property getter and setter helpers for the `UsergridUser` objects `UsergridUserProperties.Username`.
- public var username: String? {
- set(username) { self[UsergridUserProperties.Username.stringValue] = username }
- get { return self.getUserSpecificProperty(.Username) as? String }
- }
-
- /// Property getter and setter helpers for the `UsergridUser` objects `UsergridUserProperties.Password`.
- public var password: String? {
- set(password) { self[UsergridUserProperties.Password.stringValue] = password }
- get { return self.getUserSpecificProperty(.Password) as? String }
- }
-
- /// Property getter and setter helpers for the `UsergridUser` objects `UsergridUserProperties.Email`.
- public var email: String? {
- set(email) { self[UsergridUserProperties.Email.stringValue] = email }
- get { return self.getUserSpecificProperty(.Email) as? String }
- }
-
- /// Property getter and setter helpers for the `UsergridUser` objects `UsergridUserProperties.Age`.
- public var age: NSNumber? {
- set(age) { self[UsergridUserProperties.Age.stringValue] = age }
- get { return self.getUserSpecificProperty(.Age) as? NSNumber }
- }
-
- /// Property helper method to get the username or email of the `UsergridUser`.
- public var usernameOrEmail: String? { return self.username ?? self.email }
-
- /**
- Property getter and setter helpers for the `UsergridUser` objects `UsergridUserProperties.Activated`.
-
- Indicates whether the user account has been activated or not.
- */
- public var activated: Bool {
- set(activated) { self[UsergridUserProperties.Activated.stringValue] = activated }
- get { return self.getUserSpecificProperty(.Activated) as? Bool ?? false }
- }
-
- /// Property getter and setter helpers for the `UsergridUser` objects `UsergridUserProperties.Disabled`.
- public var disabled: Bool {
- set(disabled) { self[UsergridUserProperties.Disabled.stringValue] = disabled }
- get { return self.getUserSpecificProperty(.Disabled) as? Bool ?? false }
- }
-
- /**
- Property getter and setter helpers for the `UsergridUser` objects `UsergridUserProperties.Picture`.
-
- URL path to user\u2019s profile picture. Defaults to Gravatar for email address.
- */
- public var picture: String? {
- set(picture) { self[UsergridUserProperties.Picture.stringValue] = picture }
- get { return self.getUserSpecificProperty(.Picture) as? String }
- }
-
- /// The UUID or username property value if found.
- public var uuidOrUsername: String? { return self.uuid ?? self.username }
-
- // MARK: - Initialization -
-
- /**
- Designated initializer for `UsergridUser` objects.
-
- - parameter name: The name of the user. Note this is different from the `username` property.
-
- - returns: A new instance of `UsergridUser`.
- */
- public init(name:String? = nil) {
- super.init(type: UsergridUser.USER_ENTITY_TYPE, name:name, propertyDict:nil)
- }
-
- /**
- The required public initializer for `UsergridEntity` subclasses.
-
- - parameter type: The type associated with the `UsergridEntity` object.
- - parameter name: The optional name associated with the `UsergridEntity` object.
- - parameter propertyDict: The optional property dictionary that the `UsergridEntity` object will start out with.
-
- - returns: A new `UsergridUser` object.
- */
- required public init(type: String, name: String?, propertyDict: [String : AnyObject]?) {
- super.init(type: type, name: name, propertyDict: propertyDict)
- }
-
- /**
- Designated initializer for `UsergridUser` objects.
-
- - parameter name: The name of the user. Note this is different from the `username` property.
- - parameter propertyDict: The optional property dictionary that the `UsergridEntity` object will start out with.
-
- - returns: A new instance of `UsergridUser`.
- */
- public init(name:String,propertyDict:[String:AnyObject]? = nil) {
- super.init(type: UsergridUser.USER_ENTITY_TYPE, name:name, propertyDict:propertyDict)
- }
-
- /**
- Convenience initializer for `UsergridUser` objects.
-
- - parameter name: The name of the user. Note this is different from the `username` property.
- - parameter email: The user's email.
- - parameter password: The optional user's password.
-
- - returns: A new instance of `UsergridUser`.
- */
- public convenience init(name:String, email:String, password:String? = nil) {
- self.init(name:name,email:email,username:nil,password:password)
- }
-
- /**
- Convenience initializer for `UsergridUser` objects.
-
- - parameter email: The user's email.
- - parameter password: The optional user's password.
-
- - returns: A new instance of `UsergridUser`.
- */
- public convenience init(email:String, password:String? = nil) {
- self.init(name:nil,email:email,username:nil,password:password)
- }
-
- /**
- Convenience initializer for `UsergridUser` objects.
-
- - parameter name: The name of the user. Note this is different from the `username` property.
- - parameter username: The username of the user.
- - parameter password: The optional user's password.
-
- - returns: A new instance of `UsergridUser`.
- */
- public convenience init(name:String, username:String, password:String? = nil) {
- self.init(name:name,email:nil,username:username,password:password)
- }
-
- /**
- Convenience initializer for `UsergridUser` objects.
-
- - parameter username: The username of the user.
- - parameter password: The optional user's password.
-
- - returns: A new instance of `UsergridUser`.
- */
- public convenience init(username:String, password:String? = nil) {
- self.init(name:nil,email:nil,username:username,password:password)
- }
-
- /**
- Convenience initializer for `UsergridUser` objects.
-
- - parameter name: The optional name of the user. Note this is different from the `username` property.
- - parameter email: The optional user's email.
- - parameter username: The optional username of the user.
- - parameter password: The optional user's password.
-
- - returns: A new instance of `UsergridUser`.
- */
- public convenience init(name:String?, email:String?, username:String?, password:String? = nil) {
- self.init(name:name)
- self.email = email
- self.username = username
- self.password = password
- }
-
- // MARK: - NSCoding -
-
- /**
- NSCoding protocol initializer.
-
- - parameter aDecoder: The decoder.
-
- - returns: A decoded `UsergridUser` object.
- */
- required public init?(coder aDecoder: NSCoder) {
- self.auth = aDecoder.decodeObjectForKey("auth") as? UsergridUserAuth
- super.init(coder: aDecoder)
- }
-
- /**
- NSCoding protocol encoder.
-
- - parameter aCoder: The encoder.
- */
- public override func encodeWithCoder(aCoder: NSCoder) {
- aCoder.encodeObject(self.auth, forKey: "auth")
- super.encodeWithCoder(aCoder)
- }
-
- // MARK: - Class Methods -
-
- /**
- Checks the given email and/or username availablity for new `UsergridUser` objects using the shared instance of `UsergridClient`.
-
- - parameter email: The optional email address.
- - parameter username: The optional username.
- - parameter completion: The completion block.
- */
- public static func checkAvailable(email:String?, username:String?, completion:UsergridUserAvailabilityCompletion) {
- self.checkAvailable(Usergrid.sharedInstance, email: email, username: username, completion: completion)
- }
-
- /**
- Checks the given email and/or username availablity for new `UsergridUser` objects using with the given `UsergridClient`.
-
- - parameter client: The client to use for checking availability.
- - parameter email: The optional email address.
- - parameter username: The optional username.
- - parameter completion: The completion block.
- */
- public static func checkAvailable(client: UsergridClient, email:String?, username:String?, completion:UsergridUserAvailabilityCompletion) {
- let query = UsergridQuery(USER_ENTITY_TYPE)
- if let emailValue = email {
- query.eq(UsergridUserProperties.Email.stringValue, value: emailValue)
- }
- if let usernameValue = username {
- query.or().eq(UsergridUserProperties.Username.stringValue, value: usernameValue)
- }
- client.GET(query) { (response) -> Void in
- completion(error: response.error, available: response.entity == nil)
- }
- }
-
- // MARK: - Instance Methods -
-
- /**
- Creates the user object in Usergrid if the user does not already exist with the shared instance of `UsergridClient`.
-
- - parameter completion: The optional completion block.
- */
- public func create(completion: UsergridResponseCompletion? = nil) {
- self.create(Usergrid.sharedInstance, completion: completion)
- }
-
- /**
- Creates the user object in Usergrid if the user does not already exist with the given `UsergridClient`.
-
- - parameter client: The client to use for creation.
- - parameter completion: The optional completion block.
- */
- public func create(client: UsergridClient, completion: UsergridResponseCompletion? = nil) {
- client.POST(self) { (response) -> Void in
- if response.ok, let createdUser = response.user {
- self.copyInternalsFromEntity(createdUser)
- }
- completion?(response: response)
- }
- }
-
- /**
- Authenticates the specified user using the provided username and password with the shared instance of `UsergridClient`.
-
- While functionally similar to `UsergridClient.authenticateUser(auth)`, this method does not automatically assign this user to `UsergridClient.currentUser`:
-
- - parameter username: The username.
- - parameter password: The password.
- - parameter completion: The optional completion block.
- */
- public func login(username:String, password:String, completion: UsergridUserAuthCompletionBlock? = nil) {
- self.login(Usergrid.sharedInstance, username: username, password: password, completion: completion)
- }
-
- /**
- Authenticates the specified user using the provided username and password.
-
- While functionally similar to `UsergridClient.authenticateUser(auth)`, this method does not automatically assign this user to `UsergridClient.currentUser`:
-
- - parameter client: The client to use for login.
- - parameter username: The username.
- - parameter password: The password.
- - parameter completion: The optional completion block.
- */
- public func login(client: UsergridClient, username:String, password:String, completion: UsergridUserAuthCompletionBlock? = nil) {
- let userAuth = UsergridUserAuth(username: username, password: password)
- client.authenticateUser(userAuth,setAsCurrentUser:false) { (auth, user, error) -> Void in
- self.auth = userAuth
- completion?(auth: userAuth, user: user, error: error)
- }
- }
-
- /**
- Changes the User's current password with the shared instance of `UsergridClient`.
-
- - parameter old: The old password.
- - parameter new: The new password.
- - parameter completion: The optional completion block.
- */
- public func resetPassword(old:String, new:String, completion:UsergridUserResetPasswordCompletion? = nil) {
- self.resetPassword(Usergrid.sharedInstance, old: old, new: new, completion: completion)
- }
-
- /**
- Changes the User's current password with the shared instance of `UsergridClient`.
-
- - parameter client: The client to use for resetting the password.
- - parameter old: The old password.
- - parameter new: The new password.
- - parameter completion: The optional completion block
- */
- public func resetPassword(client: UsergridClient, old:String, new:String, completion:UsergridUserResetPasswordCompletion? = nil) {
- client.resetPassword(self, old: old, new: new, completion: completion)
- }
-
- /**
- Attmepts to reauthenticate using the user's `UsergridUserAuth` instance property with the shared instance of `UsergridClient`.
-
- - parameter completion: The optional completion block.
- */
- public func reauthenticate(completion: UsergridUserAuthCompletionBlock? = nil) {
- self.reauthenticate(Usergrid.sharedInstance, completion: completion)
- }
-
- /**
- Attmepts to reauthenticate using the user's `UsergridUserAuth` instance property.
-
- - parameter client: The client to use for reauthentication.
- - parameter completion: The optional completion block.
- */
- public func reauthenticate(client: UsergridClient, completion: UsergridUserAuthCompletionBlock? = nil) {
- guard let userAuth = self.auth
- else {
- completion?(auth: nil, user: self, error: UsergridResponseError(errorName: "Invalid UsergridUserAuth.", errorDescription: "No UsergridUserAuth found on the UsergridUser."))
- return
- }
-
- client.authenticateUser(userAuth, setAsCurrentUser:self.isEqualToEntity(client.currentUser), completion: completion)
- }
-
- /**
- Invalidates the user token locally and remotely.
-
- - parameter completion: The optional completion block.
- */
- public func logout(completion:UsergridResponseCompletion? = nil) {
- self.logout(Usergrid.sharedInstance,completion:completion)
- }
-
- /**
- Invalidates the user token locally and remotely.
-
- - parameter client: The client to use for logout.
- - parameter completion: The optional completion block.
- */
- public func logout(client: UsergridClient, completion:UsergridResponseCompletion? = nil) {
- guard let uuidOrUsername = self.uuidOrUsername,
- let accessToken = self.auth?.accessToken
- else {
- completion?(response: UsergridResponse(client:client, errorName:"Logout Failed.", errorDescription:"UUID or Access Token not found on UsergridUser object."))
- return
- }
-
- client.logoutUser(uuidOrUsername, token: accessToken) { (response) in
- self.auth = nil
- completion?(response: response)
- }
- }
-
- /**
- A special convenience function that connects a `UsergridDevice` to this `UsergridUser` using the shared instance of `UsergridClient`.
-
- - parameter device: The device to connect to. If nil it will use the `UsergridDevice.sharedDevice` instance.
- - parameter completion: The optional completion block.
- */
- public func connectToDevice(device:UsergridDevice? = nil, completion:UsergridResponseCompletion? = nil) {
- self.connectToDevice(Usergrid.sharedInstance, device: device, completion: completion)
- }
-
- /**
- A special convenience function that connects a `UsergridDevice` to this `UsergridUser`.
-
- - parameter client: The `UsergridClient` object to use for connecting.
- - parameter device: The device to connect to. If nil it will use the `UsergridDevice.sharedDevice` instance.
- - parameter completion: The optional completion block.
- */
- public func connectToDevice(client:UsergridClient, device:UsergridDevice? = nil, completion:UsergridResponseCompletion? = nil) {
- let deviceToConnect = device ?? UsergridDevice.sharedDevice
- guard let _ = deviceToConnect.uuidOrName
- else {
- completion?(response: UsergridResponse(client: client, errorName: "Device cannot be connected to User.", errorDescription: "Device has neither an UUID or name specified."))
- return
- }
-
- self.connect(client, relationship: "", toEntity: deviceToConnect, completion: completion)
- }
-
- /**
- Gets the connected device using the shared instance of `UsergridClient`.
-
- - parameter completion: The optional completion block.
- */
- public func getConnectedDevice(completion:UsergridResponseCompletion? = nil) {
- self.getConnectedDevice(Usergrid.sharedInstance, completion: completion)
- }
-
- /**
- Gets the connected device.
-
- - parameter client: The `UsergridClient` object to use for connecting.
- - parameter completion: The optional completion block.
- */
- public func getConnectedDevice(client:UsergridClient, completion:UsergridResponseCompletion? = nil) {
- client.getConnections(.Out, entity: self, relationship: "device", completion: completion)
- }
-
- /**
- A special convenience function that disconnects a `UsergridDevice` from this `UsergridUser` using the shared instance of `UsergridClient`.
-
- - parameter device: The device to connect to. If nil it will use the `UsergridDevice.sharedDevice` instance.
- - parameter completion: The optional completion block.
- */
- public func disconnectFromDevice(device:UsergridDevice? = nil, completion:UsergridResponseCompletion? = nil) {
- self.disconnectFromDevice(Usergrid.sharedInstance, device: device, completion: completion)
- }
-
- /**
- A special convenience function that disconnects a `UsergridDevice` from this `UsergridUser`.
-
- - parameter client: The `UsergridClient` object to use for connecting.
- - parameter device: The device to connect to.
- - parameter completion: The optional completion block.
- */
- public func disconnectFromDevice(client:UsergridClient, device:UsergridDevice? = nil, completion:UsergridResponseCompletion? = nil) {
- let deviceToDisconnectFrom = device ?? UsergridDevice.sharedDevice
- guard let _ = deviceToDisconnectFrom.uuidOrName
- else {
- completion?(response: UsergridResponse(client: client, errorName: "Device cannot be disconnected from User.", errorDescription: "Device has neither an UUID or name specified."))
- return
- }
-
- self.disconnect(client, relationship: "", fromEntity: deviceToDisconnectFrom, completion: completion)
- }
-
- private func getUserSpecificProperty(userProperty: UsergridUserProperties) -> AnyObject? {
- var propertyValue: AnyObject? = super[userProperty.stringValue]
- NSJSONReadingOptions.AllowFragments
- switch userProperty {
- case .Activated,.Disabled :
- propertyValue = propertyValue?.boolValue
- case .Age :
- propertyValue = propertyValue?.integerValue
- case .Name,.Username,.Password,.Email,.Picture :
- break
- }
- return propertyValue
- }
-
- /**
- Subscript for the `UsergridUser` class.
-
- - Warning: When setting a properties value must be a valid JSON object.
-
- - Example usage:
- ```
- let someName = usergridUser["name"]
-
- usergridUser["name"] = someName
- ```
- */
- override public subscript(propertyName: String) -> AnyObject? {
- get {
- if let userProperty = UsergridUserProperties.fromString(propertyName) {
- return self.getUserSpecificProperty(userProperty)
- } else {
- return super[propertyName]
- }
- }
- set(propertyValue) {
- super[propertyName] = propertyValue
- }
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/ASSET_Tests.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/ASSET_Tests.swift b/sdks/swift/Tests/ASSET_Tests.swift
deleted file mode 100644
index c6f860f..0000000
--- a/sdks/swift/Tests/ASSET_Tests.swift
+++ /dev/null
@@ -1,280 +0,0 @@
-//
-// ASSET_Tests.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/24/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import XCTest
-@testable import UsergridSDK
-
-class ASSET_Tests: XCTestCase {
-
- static let collectionName = "books"
- static let entityUUID = "f4078aca-2fb1-11e5-8eb2-e13f8369aad1"
- static let pngLocation = "TestAssets/test.png"
- static let jpgLocation = "TestAssets/UsergridGuy.jpg"
- static let imageName = "test"
-
- override func setUp() {
- super.setUp()
- Usergrid.initSharedInstance(orgId:ClientCreationTests.orgId, appId: ClientCreationTests.appId)
- Usergrid.persistCurrentUserInKeychain = false
- }
-
- override func tearDown() {
- Usergrid._sharedClient = nil
- super.tearDown()
- }
-
- func getFullPathOfFile(fileLocation:String) -> String {
- return (NSBundle(forClass: object_getClass(self)).resourcePath! as NSString).stringByAppendingPathComponent(fileLocation)
- }
-
- func test_ASSET_INIT() {
- var filePath = self.getFullPathOfFile(ASSET_Tests.pngLocation)
- var image = UIImage(contentsOfFile: filePath)
- var asset = UsergridAsset(filename:ASSET_Tests.imageName,image: image!)
- XCTAssertNotNil(asset)
- XCTAssertNotNil(asset!.data)
- XCTAssertNotNil(asset!.filename)
- XCTAssertEqual(asset!.contentType, UsergridImageContentType.Png.stringValue)
- XCTAssertTrue(asset!.contentLength > 0)
-
- asset = UsergridAsset(filename:ASSET_Tests.imageName, fileURL: NSURL(fileURLWithPath: filePath))
- XCTAssertNotNil(asset)
- XCTAssertNotNil(asset!.data)
- XCTAssertNotNil(asset!.filename)
- XCTAssertEqual(asset!.contentType, UsergridImageContentType.Png.stringValue)
- XCTAssertTrue(asset!.contentLength > 0)
-
- filePath = self.getFullPathOfFile(ASSET_Tests.jpgLocation)
- image = UIImage(contentsOfFile: filePath)
- asset = UsergridAsset(filename:nil,image: image!, imageContentType:.Jpeg)
- XCTAssertNotNil(asset)
- XCTAssertNotNil(asset!.data)
- XCTAssertEqual(asset!.filename,UsergridAsset.DEFAULT_FILE_NAME)
- XCTAssertEqual(asset!.contentType, UsergridImageContentType.Jpeg.stringValue)
- XCTAssertTrue(asset!.contentLength > 0)
- }
-
- func test_IMAGE_UPLOAD() {
- let getExpect = self.expectationWithDescription("\(#function)")
- let uploadProgress : UsergridAssetRequestProgress = { (bytes,expected) in
- print("UPLOAD PROGRESS BLOCK: BYTES:\(bytes) --- EXPECTED:\(expected)")
- }
- let downloadProgress : UsergridAssetRequestProgress = { (bytes,expected) in
- print("DOWNLOAD PROGRESS BLOCK: BYTES:\(bytes) --- EXPECTED:\(expected)")
- }
-
- Usergrid.GET(ASSET_Tests.collectionName, uuidOrName:ASSET_Tests.entityUUID) { (response) in
- XCTAssertTrue(NSThread.isMainThread())
-
- let entity = response.first!
- XCTAssertNotNil(entity)
- XCTAssertFalse(entity.isUser)
-
- let imagePath = self.getFullPathOfFile(ASSET_Tests.pngLocation)
- XCTAssertNotNil(imagePath)
-
- let localImage = UIImage(contentsOfFile: imagePath)
- XCTAssertNotNil(localImage)
-
- let asset = UsergridAsset(filename:ASSET_Tests.imageName,image: localImage!)
- XCTAssertNotNil(asset)
-
- entity.uploadAsset(asset!, progress:uploadProgress) { uploadedAsset,response in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertTrue(response.ok)
- XCTAssertNil(response.error)
-
- XCTAssertNotNil(asset)
- XCTAssertNotNil(uploadedAsset)
- XCTAssertEqual(uploadedAsset!, asset!)
-
- XCTAssertTrue(entity.hasAsset)
- XCTAssertNotNil(entity.fileMetaData)
- XCTAssertNotNil(entity.fileMetaData!.eTag)
- XCTAssertNotNil(entity.fileMetaData!.checkSum)
- XCTAssertNotNil(entity.fileMetaData!.contentType)
- XCTAssertNotNil(entity.fileMetaData!.lastModifiedDate)
- XCTAssertEqual(entity.asset!.contentLength, entity.fileMetaData!.contentLength)
- XCTAssertEqual(entity.asset!.contentType, entity.fileMetaData!.contentType)
-
- entity.downloadAsset(UsergridImageContentType.Png.stringValue, progress:downloadProgress)
- { (downloadedAsset, error) -> Void in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(downloadedAsset)
- XCTAssertNil(error)
- let downloadedImage = UIImage(data: downloadedAsset!.data)
- XCTAssertEqual(UIImagePNGRepresentation(localImage!), UIImagePNGRepresentation(downloadedImage!))
- XCTAssertNotNil(downloadedImage)
- getExpect.fulfill()
- }
- }
- }
- self.waitForExpectationsWithTimeout(100, handler: nil)
- }
-
- func deleteUser(user:UsergridUser,expectation:XCTestExpectation) {
- user.remove() { removeResponse in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(removeResponse)
- XCTAssertTrue(removeResponse.ok)
- XCTAssertNotNil(removeResponse.user)
- XCTAssertNotNil(removeResponse.users)
- print(removeResponse.error)
- expectation.fulfill()
- }
- }
-
- func test_ATTACH_ASSET_TO_CURRENT_USER() {
- let userAssetExpect = self.expectationWithDescription("\(#function)")
-
- let user = UsergridUser(name:User_Tests.name, email:User_Tests.email, username:User_Tests.username, password:User_Tests.password)
- let uploadProgress : UsergridAssetRequestProgress = { (bytes,expected) in
- print("UPLOAD PROGRESS BLOCK: BYTES:\(bytes) --- EXPECTED:\(expected)")
- }
- let downloadProgress : UsergridAssetRequestProgress = { (bytes,expected) in
- print("DOWNLOAD PROGRESS BLOCK: BYTES:\(bytes) --- EXPECTED:\(expected)")
- }
-
- UsergridUser.checkAvailable(user.email, username: user.username) { error,available in
-
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertTrue(available)
-
- user.create() { (createResponse) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(createResponse)
- XCTAssertTrue(createResponse.ok)
- XCTAssertNotNil(createResponse.user)
- XCTAssertNotNil(createResponse.users)
- XCTAssertNotNil(user.uuid)
-
- user.login(user.username!, password:User_Tests.password) { (auth, loggedInUser, error) -> Void in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertNotNil(auth)
- XCTAssertNotNil(loggedInUser)
- XCTAssertEqual(auth, user.auth!)
-
- Usergrid.authenticateUser(user.auth!) { auth,currentUser,error in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertNotNil(auth)
- XCTAssertEqual(auth, user.auth!)
-
- XCTAssertNotNil(currentUser)
- XCTAssertNotNil(Usergrid.currentUser)
- XCTAssertEqual(currentUser, Usergrid.currentUser!)
-
- let imagePath = self.getFullPathOfFile(ASSET_Tests.pngLocation)
- XCTAssertNotNil(imagePath)
-
- let localImage = UIImage(contentsOfFile: imagePath)
- XCTAssertNotNil(localImage)
-
- let asset = UsergridAsset(filename:ASSET_Tests.imageName,image: localImage!)
- XCTAssertNotNil(asset)
-
- Usergrid.currentUser!.uploadAsset(asset!, progress:uploadProgress) { uploadedAsset,response in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertTrue(response.ok)
- XCTAssertNil(response.error)
-
- XCTAssertNotNil(asset)
- XCTAssertNotNil(uploadedAsset)
- XCTAssertEqual(uploadedAsset!, asset!)
-
- XCTAssertTrue(Usergrid.currentUser!.hasAsset)
- XCTAssertNotNil(Usergrid.currentUser!.fileMetaData)
- XCTAssertNotNil(Usergrid.currentUser!.fileMetaData!.eTag)
- XCTAssertNotNil(Usergrid.currentUser!.fileMetaData!.checkSum)
- XCTAssertNotNil(Usergrid.currentUser!.fileMetaData!.contentType)
- XCTAssertNotNil(Usergrid.currentUser!.fileMetaData!.lastModifiedDate)
- XCTAssertEqual(Usergrid.currentUser!.asset!.contentLength, Usergrid.currentUser!.fileMetaData!.contentLength)
- XCTAssertEqual(Usergrid.currentUser!.asset!.contentType, Usergrid.currentUser!.fileMetaData!.contentType)
-
- Usergrid.currentUser!.downloadAsset(UsergridImageContentType.Png.stringValue, progress:downloadProgress)
- { (downloadedAsset, error) -> Void in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(downloadedAsset)
- XCTAssertNil(error)
- let downloadedImage = UIImage(data: downloadedAsset!.data)
- XCTAssertEqual(UIImagePNGRepresentation(localImage!), UIImagePNGRepresentation(downloadedImage!))
- XCTAssertNotNil(downloadedImage)
- self.deleteUser(Usergrid.currentUser!,expectation:userAssetExpect)
- }
- }
- }
- }
- }
- }
- self.waitForExpectationsWithTimeout(100, handler: nil)
- }
-
-
- func test_FILE_META_DATA_NSCODING() {
- let fileMetaDataDict = ["content-type":"image/png",
- "etag":"dfa7421ea4f35d33e12ba93979a46b7e",
- "checkSum":"dfa7421ea4f35d33e12ba93979a46b7e",
- "content-length":1417896,
- "last-modified":1455728898545]
-
- let fileMetaData = UsergridFileMetaData(fileMetaDataJSON:fileMetaDataDict)
-
- let fileMetaDataCodingData = NSKeyedArchiver.archivedDataWithRootObject(fileMetaData)
- let newInstanceFromData = NSKeyedUnarchiver.unarchiveObjectWithData(fileMetaDataCodingData) as? UsergridFileMetaData
- XCTAssertNotNil(newInstanceFromData)
-
- if let newInstance = newInstanceFromData {
- XCTAssertEqual(fileMetaData.eTag,newInstance.eTag)
- XCTAssertEqual(fileMetaData.checkSum,newInstance.checkSum)
- XCTAssertEqual(fileMetaData.contentType,newInstance.contentType)
- XCTAssertEqual(fileMetaData.contentLength,newInstance.contentLength)
- XCTAssertEqual(fileMetaData.lastModifiedDate,newInstance.lastModifiedDate)
- }
- }
-
- func test_ASSET_NSCODING() {
- let imagePath = self.getFullPathOfFile(ASSET_Tests.pngLocation)
- let asset = UsergridAsset(filename:ASSET_Tests.imageName,fileURL: NSURL(fileURLWithPath: imagePath))
- XCTAssertNotNil(asset)
-
- if let originalAsset = asset {
- let assetCodingData = NSKeyedArchiver.archivedDataWithRootObject(originalAsset)
- let newInstanceFromData = NSKeyedUnarchiver.unarchiveObjectWithData(assetCodingData) as? UsergridAsset
-
- XCTAssertNotNil(newInstanceFromData)
-
- if let newInstance = newInstanceFromData {
- XCTAssertEqual(originalAsset.filename,newInstance.filename)
- XCTAssertEqual(originalAsset.data,newInstance.data)
- XCTAssertEqual(originalAsset.originalLocation,newInstance.originalLocation)
- XCTAssertEqual(originalAsset.contentType,newInstance.contentType)
- XCTAssertEqual(originalAsset.contentLength,newInstance.contentLength)
- }
- }
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/AUTH_Tests.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/AUTH_Tests.swift b/sdks/swift/Tests/AUTH_Tests.swift
deleted file mode 100644
index 80ec695..0000000
--- a/sdks/swift/Tests/AUTH_Tests.swift
+++ /dev/null
@@ -1,132 +0,0 @@
-//
-// AUTH_Tests.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/17/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import XCTest
-@testable import UsergridSDK
-
-class AUTH_Tests: XCTestCase {
-
- var appAuth: UsergridAppAuth!
- var userAuth: UsergridUserAuth!
-
- private static let collectionName = "publicevent"
- private static let entityUUID = "fa015eaa-fe1c-11e3-b94b-63b29addea01"
-
- override func setUp() {
- super.setUp()
- appAuth = UsergridAppAuth(clientId: "b3U6THNcevskEeOQZLcUROUUVA", clientSecret: "b3U6RZHYznP28xieBzQPackFPmmnevU")
- userAuth = UsergridUserAuth(username: "username", password: "password")
- Usergrid.initSharedInstance(orgId:ClientCreationTests.orgId, appId: "sdk.demo")
- }
-
- override func tearDown() {
- Usergrid._sharedClient = nil
- super.tearDown()
- }
-
- func test_CLIENT_AUTH() {
-
- let authExpect = self.expectationWithDescription("\(#function)")
- Usergrid.authMode = .App
- Usergrid.authenticateApp(appAuth) { auth,error in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertNotNil(Usergrid.appAuth)
-
- if let appAuth = Usergrid.appAuth {
-
- XCTAssertNotNil(appAuth.accessToken)
- XCTAssertNotNil(appAuth.expiry)
- XCTAssertNotNil(appAuth.isValid)
-
- Usergrid.GET(AUTH_Tests.collectionName) { (response) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.hasNextPage)
- XCTAssertEqual(response.entities!.count, 10)
- XCTAssertEqual(response.first!.type, AUTH_Tests.collectionName)
-
- authExpect.fulfill()
- }
- }
- }
- self.waitForExpectationsWithTimeout(100, handler: nil)
- }
-
- func test_DESTROY_AUTH() {
- let auth = UsergridAuth(accessToken: "YWMt91Q2YtWaEeW_Ki2uDueMEwAAAVMUTVSPeOdX-oradxdqirEFz5cPU3GWybs")
-
- XCTAssertTrue(auth.isValid)
- XCTAssertNotNil(auth.accessToken)
- XCTAssertNil(auth.expiry)
-
- auth.destroy()
-
- XCTAssertFalse(auth.isValid)
- XCTAssertNil(auth.accessToken)
- XCTAssertNil(auth.expiry)
- }
-
- func test_APP_AUTH_NSCODING() {
-
- appAuth.accessToken = "YWMt91Q2YtWaEeW_Ki2uDueMEwAAAVMUTVSPeOdX-oradxdqirEFz5cPU3GWybs"
- appAuth.expiry = NSDate.distantFuture()
-
- let authCodingData = NSKeyedArchiver.archivedDataWithRootObject(appAuth)
- let newInstanceFromData = NSKeyedUnarchiver.unarchiveObjectWithData(authCodingData) as? UsergridAppAuth
-
- XCTAssertNotNil(newInstanceFromData)
-
- if let newInstance = newInstanceFromData {
- XCTAssertTrue(appAuth.isValid)
- XCTAssertTrue(newInstance.isValid)
- XCTAssertEqual(appAuth.clientId,newInstance.clientId)
- XCTAssertEqual(appAuth.accessToken,newInstance.accessToken)
- XCTAssertEqual(appAuth.expiry,newInstance.expiry)
- }
- }
-
- func test_USER_AUTH_NSCODING() {
-
- userAuth.accessToken = "YWMt91Q2YtWaEeW_Ki2uDueMEwAAAVMUTVSPeOdX-oradxdqirEFz5cPU3GWybs"
- userAuth.expiry = NSDate.distantFuture()
-
- let authCodingData = NSKeyedArchiver.archivedDataWithRootObject(userAuth)
- let newInstanceFromData = NSKeyedUnarchiver.unarchiveObjectWithData(authCodingData) as? UsergridUserAuth
-
- XCTAssertNotNil(newInstanceFromData)
-
- if let newInstance = newInstanceFromData {
- XCTAssertTrue(userAuth.isValid)
- XCTAssertTrue(newInstance.isValid)
- XCTAssertEqual(userAuth.username,newInstance.username)
- XCTAssertEqual(userAuth.accessToken,newInstance.accessToken)
- XCTAssertEqual(userAuth.expiry,newInstance.expiry)
- }
- }
-
-
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/CONNECTION_Tests.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/CONNECTION_Tests.swift b/sdks/swift/Tests/CONNECTION_Tests.swift
deleted file mode 100644
index 2640778..0000000
--- a/sdks/swift/Tests/CONNECTION_Tests.swift
+++ /dev/null
@@ -1,105 +0,0 @@
-//
-// CONNECTION_Tests.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 10/5/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import XCTest
-@testable import UsergridSDK
-
-class CONNECTION_Tests: XCTestCase {
-
- let clientAuth = UsergridAppAuth(clientId: "b3U6THNcevskEeOQZLcUROUUVA", clientSecret: "b3U6RZHYznP28xieBzQPackFPmmnevU")
- private static let collectionName = "publicevent"
-
- override func setUp() {
- super.setUp()
- Usergrid.initSharedInstance(orgId:ClientCreationTests.orgId, appId: "sdk.demo")
- }
-
- override func tearDown() {
- Usergrid._sharedClient = nil
- super.tearDown()
- }
-
- func test_CLIENT_AUTH() {
-
- let authExpect = self.expectationWithDescription("\(#function)")
- Usergrid.authMode = .App
- Usergrid.authenticateApp(clientAuth) { auth,error in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertNotNil(Usergrid.appAuth)
-
- if let appAuth = Usergrid.appAuth {
-
- XCTAssertNotNil(appAuth.accessToken)
- XCTAssertNotNil(appAuth.expiry)
-
- Usergrid.GET(CONNECTION_Tests.collectionName) { (response) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
- XCTAssertTrue(response.hasNextPage)
- XCTAssertEqual(response.entities!.count, 10)
-
- let entity = response.first!
- let entityToConnect = response.entities![1]
- XCTAssertEqual(entity.type, CONNECTION_Tests.collectionName)
-
- entity.connect("likes", toEntity: entityToConnect) { (response) -> Void in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
-
- entity.getConnections(.Out, relationship: "likes", query:nil) { (response) -> Void in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
-
- let connectedEntity = response.first!
- XCTAssertNotNil(connectedEntity)
- XCTAssertEqual(connectedEntity.uuidOrName, entityToConnect.uuidOrName)
-
- entity.disconnect("likes", fromEntity: connectedEntity) { (response) -> Void in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
-
- entity.getConnections(.Out, relationship: "likes", query:nil) { (response) -> Void in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
- authExpect.fulfill()
- }
- }
- }
- }
- }
- } else {
- authExpect.fulfill()
- }
- }
- self.waitForExpectationsWithTimeout(20, handler: nil)
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/ClientCreationTests.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/ClientCreationTests.swift b/sdks/swift/Tests/ClientCreationTests.swift
deleted file mode 100644
index 40a7de1..0000000
--- a/sdks/swift/Tests/ClientCreationTests.swift
+++ /dev/null
@@ -1,74 +0,0 @@
-//
-// ClientCreationTests.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 7/31/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import XCTest
-@testable import UsergridSDK
-
-class ClientCreationTests: XCTestCase {
-
- static let orgId = "rwalsh"
- static let appId = "sandbox"
-
- override func setUp() {
- super.setUp()
- Usergrid.initSharedInstance(orgId:ClientCreationTests.orgId, appId: ClientCreationTests.appId)
- Usergrid.persistCurrentUserInKeychain = false
- }
-
- override func tearDown() {
- Usergrid._sharedClient = nil
- super.tearDown()
- }
-
- func test_INSTANCE_POINTERS() {
- XCTAssertNotNil(Usergrid.sharedInstance)
- }
-
- func test_CLIENT_PROPERTIES() {
- XCTAssertEqual(Usergrid.appId, ClientCreationTests.appId)
- XCTAssertEqual(Usergrid.orgId, ClientCreationTests.orgId)
- XCTAssertEqual(Usergrid.authMode, UsergridAuthMode.User)
- XCTAssertEqual(Usergrid.persistCurrentUserInKeychain, false)
- XCTAssertEqual(Usergrid.baseUrl, UsergridClient.DEFAULT_BASE_URL)
- XCTAssertEqual(Usergrid.clientAppURL, "\(UsergridClient.DEFAULT_BASE_URL)/\(ClientCreationTests.orgId)/\(ClientCreationTests.appId)" )
- XCTAssertNil(Usergrid.currentUser)
- XCTAssertNil(Usergrid.userAuth)
- }
-
- func test_CLIENT_NSCODING() {
- let sharedInstanceAsData = NSKeyedArchiver.archivedDataWithRootObject(Usergrid.sharedInstance)
- let newInstanceFromData = NSKeyedUnarchiver.unarchiveObjectWithData(sharedInstanceAsData) as? UsergridClient
-
- XCTAssertNotNil(newInstanceFromData)
-
- if let newInstance = newInstanceFromData {
- XCTAssertEqual(Usergrid.appId, newInstance.appId)
- XCTAssertEqual(Usergrid.orgId, newInstance.orgId)
- XCTAssertEqual(Usergrid.authMode, newInstance.authMode)
- XCTAssertEqual(Usergrid.baseUrl, newInstance.baseUrl)
- }
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/Entity_Tests.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/Entity_Tests.swift b/sdks/swift/Tests/Entity_Tests.swift
deleted file mode 100644
index 439b67d..0000000
--- a/sdks/swift/Tests/Entity_Tests.swift
+++ /dev/null
@@ -1,173 +0,0 @@
-//
-// Entity_Tests.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/22/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import XCTest
-@testable import UsergridSDK
-
-class Entity_Tests: XCTestCase {
-
- let entity = UsergridEntity(type: "entityType", name:"entityName")
- let customArrayName = "customArray"
- let customArrayOriginalValue = [1,2,3,4,5]
- let customPropertyName = "customProperty"
- let customPropertyValue = 99
-
- func test_PUT_PROPERTY() {
-
- entity.putProperty(customArrayName, value: customArrayOriginalValue)
-
- let propertyValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(propertyValue)
- XCTAssertEqual(propertyValue!, customArrayOriginalValue)
- }
- func test_PUT_PROPERTIES() {
-
- entity.putProperties([customArrayName:customArrayOriginalValue])
-
- let propertyValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(propertyValue)
- XCTAssertEqual(propertyValue!, customArrayOriginalValue)
- }
- func test_REMOVE_PROPERTY() {
- entity[customArrayName] = customArrayOriginalValue
- let propertyValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(propertyValue)
-
- entity.removeProperty(customArrayName)
-
- XCTAssertNil(entity[customArrayName])
- }
- func test_REMOVE_PROPERTIES() {
- entity[customArrayName] = customArrayOriginalValue
- let propertyValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(propertyValue)
-
- entity.removeProperties([customArrayName])
-
- XCTAssertNil(entity[customArrayName])
- }
- func test_PUSH() {
- entity[customArrayName] = customArrayOriginalValue
-
- entity.append(customArrayName,value:6)
-
- let newValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [1,2,3,4,5,6])
- }
- func test_APPEND() {
- entity[customArrayName] = customArrayOriginalValue
-
- entity.append(customArrayName,value:[6,7])
-
- let newValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [1,2,3,4,5,6,7])
- }
- func test_INSERT_WITHOUT_INDEX() {
- entity[customArrayName] = customArrayOriginalValue
-
- entity.insert(customArrayName,value:6)
-
- let newValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [6,1,2,3,4,5])
- }
- func test_INSERT_WITH_INDEX() {
- entity[customArrayName] = customArrayOriginalValue
-
- entity.insert(customArrayName,value:6,index:1)
-
- let newValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [1,6,2,3,4,5])
- }
- func test_INSERT_ARRAY_WITHOUT_INDEX() {
- entity[customArrayName] = customArrayOriginalValue
-
- entity.insert(customArrayName,value:[6,7])
-
- let newValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [6,7,1,2,3,4,5])
- }
-
- func test_INSERT_ARRAY_WITH_INDEX() {
- entity[customArrayName] = customArrayOriginalValue
-
- entity.insert(customArrayName,value:[6,7],index:1)
-
- let newValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [1,6,7,2,3,4,5])
- }
-
- func test_INSERT_ARRAY_TO_NON_EXISTENT_PROPERTY() {
- entity.insert(customArrayName,value:customArrayOriginalValue)
-
- let newValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [1,2,3,4,5])
- }
-
- func test_INSERT_ARRAY_TO_NON_ARRAY_PROPERTY_WITHOUT_INDEX() {
- entity[customPropertyName] = customPropertyValue
-
- entity.insert(customPropertyName,value:customArrayOriginalValue)
-
- let newValue = entity[customPropertyName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [1,2,3,4,5,99])
- }
-
- func test_INSERT_ARRAY_TO_NON_ARRAY_PROPERTY_WITH_INDEX() {
- entity[customPropertyName] = customPropertyValue
-
- entity.insert(customPropertyName,value:customArrayOriginalValue,index:1)
-
- let newValue = entity[customPropertyName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [99,1,2,3,4,5])
- }
- func test_POP() {
- entity[customArrayName] = customArrayOriginalValue
-
- entity.pop(customArrayName)
-
- let newValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [1,2,3,4])
- }
- func test_SHIFT() {
- entity[customArrayName] = customArrayOriginalValue
-
- entity.shift(customArrayName)
-
- let newValue = entity[customArrayName] as? [Int]
- XCTAssertNotNil(newValue)
- XCTAssertEqual(newValue!, [2,3,4,5])
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/GET_Tests.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/GET_Tests.swift b/sdks/swift/Tests/GET_Tests.swift
deleted file mode 100644
index 2b0331f..0000000
--- a/sdks/swift/Tests/GET_Tests.swift
+++ /dev/null
@@ -1,113 +0,0 @@
-//
-// GET_Tests.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/2/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import XCTest
-@testable import UsergridSDK
-
-class GET_Tests: XCTestCase {
-
- static let collectionName = "books"
- static let entityUUID = "f4078aca-2fb1-11e5-8eb2-e13f8369aad1"
-
- let query = UsergridQuery(GET_Tests.collectionName).eq("title", value: "The Sun Also Rises").or().eq("title", value: "The Old Man and the Sea")
-
- override func setUp() {
- super.setUp()
- Usergrid.initSharedInstance(orgId:ClientCreationTests.orgId, appId: ClientCreationTests.appId)
- }
-
- override func tearDown() {
- Usergrid._sharedClient = nil
- super.tearDown()
- }
-
- func test_GET_WITHOUT_QUERY() {
-
- let getExpect = self.expectationWithDescription("\(#function)")
- Usergrid.GET(GET_Tests.collectionName) { (response) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
- XCTAssertTrue(response.hasNextPage)
- XCTAssertEqual(response.count, 10)
- getExpect.fulfill()
- }
- self.waitForExpectationsWithTimeout(10, handler: nil)
- }
-
- func test_GET_WITH_QUERY() {
-
- let getExpect = self.expectationWithDescription("\(#function)")
- Usergrid.GET(self.query) { (response) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
- XCTAssertEqual(response.count, 1)
- getExpect.fulfill()
- }
- self.waitForExpectationsWithTimeout(10, handler: nil)
- }
-
- func test_GET_WITH_UUID() {
-
- let getExpect = self.expectationWithDescription("\(#function)")
- Usergrid.GET(GET_Tests.collectionName, uuidOrName:GET_Tests.entityUUID) { (response) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
- let entity = response.first!
- XCTAssertFalse(response.hasNextPage)
- XCTAssertEqual(response.count, 1)
- XCTAssertNotNil(entity)
- XCTAssertEqual(entity.uuid!, GET_Tests.entityUUID)
- getExpect.fulfill()
- }
- self.waitForExpectationsWithTimeout(10, handler: nil)
- }
-
- func test_GET_NEXT_PAGE_WITH_NO_QUERY() {
-
- let getExpect = self.expectationWithDescription("\(#function)")
- Usergrid.GET(GET_Tests.collectionName) { (response) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
- XCTAssertTrue(response.hasNextPage)
- XCTAssertEqual(response.count, 10)
-
- response.loadNextPage() { (nextPageResponse) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertTrue(nextPageResponse.ok)
- XCTAssertNotNil(nextPageResponse)
- XCTAssertFalse(nextPageResponse.hasNextPage)
- XCTAssertEqual(nextPageResponse.entities!.count, 7)
- getExpect.fulfill()
- }
- }
- self.waitForExpectationsWithTimeout(20, handler: nil)
- }
-
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/Info.plist
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/Info.plist b/sdks/swift/Tests/Info.plist
deleted file mode 100644
index ba72822..0000000
--- a/sdks/swift/Tests/Info.plist
+++ /dev/null
@@ -1,24 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
- <key>CFBundleDevelopmentRegion</key>
- <string>en</string>
- <key>CFBundleExecutable</key>
- <string>$(EXECUTABLE_NAME)</string>
- <key>CFBundleIdentifier</key>
- <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
- <key>CFBundleInfoDictionaryVersion</key>
- <string>6.0</string>
- <key>CFBundleName</key>
- <string>$(PRODUCT_NAME)</string>
- <key>CFBundlePackageType</key>
- <string>BNDL</string>
- <key>CFBundleShortVersionString</key>
- <string>1.0</string>
- <key>CFBundleSignature</key>
- <string>????</string>
- <key>CFBundleVersion</key>
- <string>1</string>
-</dict>
-</plist>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/PUT_Tests.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/PUT_Tests.swift b/sdks/swift/Tests/PUT_Tests.swift
deleted file mode 100644
index b1ff3e7..0000000
--- a/sdks/swift/Tests/PUT_Tests.swift
+++ /dev/null
@@ -1,158 +0,0 @@
-//
-// PUT_Tests.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/11/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import XCTest
-@testable import UsergridSDK
-
-class PUT_Tests: XCTestCase {
-
- let query = UsergridQuery(PUT_Tests.collectionName)
- .eq("title", value: "The Sun Also Rises")
- .or()
- .eq("title", value: "The Old Man and the Sea")
-
- static let collectionName = "books"
- static let entityUUID = "f4078aca-2fb1-11e5-8eb2-e13f8369aad1"
-
- override func setUp() {
- super.setUp()
- Usergrid.initSharedInstance(orgId:ClientCreationTests.orgId, appId: ClientCreationTests.appId)
- }
-
- override func tearDown() {
- Usergrid._sharedClient = nil
- super.tearDown()
- }
-
- func test_PUT_BY_SPECIFYING_UUID_AS_PARAMETER() {
-
- let propertyNameToUpdate = "\(#function)"
- let propertiesNewValue = "\(propertyNameToUpdate)_VALUE"
- let putExpect = self.expectationWithDescription(propertyNameToUpdate)
-
- Usergrid.PUT(PUT_Tests.collectionName, uuidOrName: PUT_Tests.entityUUID, jsonBody:[propertyNameToUpdate : propertiesNewValue]) { (response) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
- XCTAssertEqual(response.entities!.count, 1)
- let entity = response.first!
-
- XCTAssertNotNil(entity)
- XCTAssertEqual(entity.uuid!, PUT_Tests.entityUUID)
-
- let updatedPropertyValue = entity[propertyNameToUpdate] as? String
- XCTAssertNotNil(updatedPropertyValue)
- XCTAssertEqual(updatedPropertyValue!,propertiesNewValue)
- putExpect.fulfill()
- }
- self.waitForExpectationsWithTimeout(10, handler: nil)
- }
-
- func test_PUT_BY_SPECIFYING_UUID_WITHIN_JSON_BODY() {
-
- let propertyNameToUpdate = "\(#function)"
- let propertiesNewValue = "\(propertyNameToUpdate)_VALUE"
- let putExpect = self.expectationWithDescription(propertyNameToUpdate)
-
- let jsonDictToPut = [UsergridEntityProperties.UUID.stringValue : PUT_Tests.entityUUID, propertyNameToUpdate : propertiesNewValue]
-
- Usergrid.PUT(PUT_Tests.collectionName, jsonBody: jsonDictToPut) { (response) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
- XCTAssertEqual(response.entities!.count, 1)
- let entity = response.first!
-
- XCTAssertNotNil(entity)
- XCTAssertEqual(entity.uuid!, PUT_Tests.entityUUID)
-
- let updatedPropertyValue = entity[propertyNameToUpdate] as? String
- XCTAssertNotNil(updatedPropertyValue)
- XCTAssertEqual(updatedPropertyValue!,propertiesNewValue)
- putExpect.fulfill()
- }
- self.waitForExpectationsWithTimeout(10, handler: nil)
- }
-
- func test_PUT_WITH_ENTITY_OBJECT() {
- let propertyNameToUpdate = "\(#function)"
- let propertiesNewValue = "\(propertyNameToUpdate)_VALUE"
- let putExpect = self.expectationWithDescription(propertyNameToUpdate)
-
- Usergrid.GET(PUT_Tests.collectionName, uuidOrName: PUT_Tests.entityUUID) { (getResponse) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(getResponse)
- XCTAssertTrue(getResponse.ok)
- XCTAssertEqual(getResponse.entities!.count, 1)
-
- var responseEntity = getResponse.first!
-
- XCTAssertNotNil(responseEntity)
- XCTAssertEqual(responseEntity.uuid!, PUT_Tests.entityUUID)
-
- responseEntity[propertyNameToUpdate] = propertiesNewValue
-
- Usergrid.PUT(responseEntity) { (putResponse) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(putResponse)
- XCTAssertTrue(putResponse.ok)
- XCTAssertEqual(putResponse.entities!.count, 1)
- responseEntity = putResponse.first!
-
- XCTAssertNotNil(responseEntity)
- XCTAssertEqual(responseEntity.uuid!, PUT_Tests.entityUUID)
-
- let updatedPropertyValue = responseEntity[propertyNameToUpdate] as? String
- XCTAssertNotNil(updatedPropertyValue)
- XCTAssertEqual(updatedPropertyValue!,propertiesNewValue)
- putExpect.fulfill()
- }
- }
- self.waitForExpectationsWithTimeout(20, handler: nil)
- }
-
- func test_PUT_WITH_QUERY() {
- let propertyNameToUpdate = "\(#function)"
- let propertiesNewValue = "\(propertyNameToUpdate)_VALUE"
- let putExpect = self.expectationWithDescription(propertyNameToUpdate)
-
- Usergrid.PUT(self.query, jsonBody: [propertyNameToUpdate : propertiesNewValue]) { (putResponse) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(putResponse)
- XCTAssertTrue(putResponse.ok)
- XCTAssertEqual(putResponse.entities!.count, 1)
-
- let responseEntity = putResponse.first!
- XCTAssertNotNil(responseEntity)
-
- let updatedPropertyValue = responseEntity[propertyNameToUpdate] as? String
- XCTAssertNotNil(updatedPropertyValue)
- XCTAssertEqual(updatedPropertyValue!,propertiesNewValue)
- putExpect.fulfill()
- }
- self.waitForExpectationsWithTimeout(10, handler: nil)
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/TestAssets/UsergridGuy.jpg
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/TestAssets/UsergridGuy.jpg b/sdks/swift/Tests/TestAssets/UsergridGuy.jpg
deleted file mode 100644
index 035dd7b..0000000
Binary files a/sdks/swift/Tests/TestAssets/UsergridGuy.jpg and /dev/null differ
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/TestAssets/logo_apigee.png
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/TestAssets/logo_apigee.png b/sdks/swift/Tests/TestAssets/logo_apigee.png
deleted file mode 100644
index 5113800..0000000
Binary files a/sdks/swift/Tests/TestAssets/logo_apigee.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/TestAssets/test.png
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/TestAssets/test.png b/sdks/swift/Tests/TestAssets/test.png
deleted file mode 100644
index 4b13eaa..0000000
Binary files a/sdks/swift/Tests/TestAssets/test.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Tests/User_Tests.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Tests/User_Tests.swift b/sdks/swift/Tests/User_Tests.swift
deleted file mode 100644
index dcb5545..0000000
--- a/sdks/swift/Tests/User_Tests.swift
+++ /dev/null
@@ -1,399 +0,0 @@
-//
-// User_Tests.swift
-// UsergridSDK
-//
-// Created by Robert Walsh on 9/14/15.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import XCTest
-import CoreLocation
-@testable import UsergridSDK
-
-class User_Tests: XCTestCase {
-
- var user: UsergridUser!
-
- static let name = "Robert Walsh"
- static let age = 29
- static let email = "handsomeRob741@yahoo.com"
- static let username = "rwalsh"
- static let password = "password"
- static let resetPassword = "password111"
- static let picture = "http://www.gravatar.com/avatar/e466d447df831ddce35fbc50763fb03a"
- static let activated = true
- static let disabled = false
-
- override func setUp() {
- super.setUp()
-
- Usergrid.initSharedInstance(orgId:ClientCreationTests.orgId, appId: ClientCreationTests.appId)
- Usergrid.persistCurrentUserInKeychain = false
-
- user = UsergridUser(name:"a_bogus_name", email:User_Tests.email, username:User_Tests.username, password:User_Tests.password)
- user.name = User_Tests.name
- user.age = User_Tests.age
- user.location = CLLocation(latitude: -90, longitude: 100)
- user.picture = User_Tests.picture
- user.activated = User_Tests.activated
- user.disabled = User_Tests.disabled
- }
-
- override func tearDown() {
- Usergrid._sharedClient = nil
- super.tearDown()
- }
-
- func test_USER_INIT() {
- user = UsergridUser(email: User_Tests.email, password: User_Tests.password)
- XCTAssertNotNil(user)
- XCTAssertNotNil(user.email)
- XCTAssertNotNil(user.password)
- XCTAssertEqual(user.email!, User_Tests.email)
- XCTAssertEqual(user.usernameOrEmail!, User_Tests.email)
- XCTAssertEqual(user.password!, User_Tests.password)
- XCTAssertFalse(user.activated)
- XCTAssertFalse(user.disabled)
-
- user = UsergridUser(name: User_Tests.name, propertyDict: ["password":User_Tests.password])
- XCTAssertNotNil(user)
- XCTAssertNotNil(user.name)
- XCTAssertNotNil(user.password)
- XCTAssertEqual(user.name!, User_Tests.name)
- XCTAssertEqual(user.password!, User_Tests.password)
- XCTAssertFalse(user.activated)
- XCTAssertFalse(user.disabled)
-
- user = UsergridUser(name:User_Tests.name, email: User_Tests.email, password: User_Tests.password)
- XCTAssertNotNil(user)
- XCTAssertNotNil(user.name)
- XCTAssertNotNil(user.email)
- XCTAssertNotNil(user.password)
- XCTAssertEqual(user.name!, User_Tests.name)
- XCTAssertEqual(user.email!, User_Tests.email)
- XCTAssertEqual(user.usernameOrEmail!, User_Tests.email)
- XCTAssertEqual(user.password!, User_Tests.password)
- XCTAssertFalse(user.activated)
- XCTAssertFalse(user.disabled)
-
- user = UsergridUser(username: User_Tests.username, password: User_Tests.password)
- XCTAssertNotNil(user)
- XCTAssertNotNil(user.username)
- XCTAssertNotNil(user.password)
- XCTAssertEqual(user.username!, User_Tests.username)
- XCTAssertEqual(user.usernameOrEmail!, User_Tests.username)
- XCTAssertEqual(user.password!, User_Tests.password)
- XCTAssertFalse(user.activated)
- XCTAssertFalse(user.disabled)
-
- user = UsergridUser(name: User_Tests.name, username: User_Tests.username, password: User_Tests.password)
- XCTAssertNotNil(user)
- XCTAssertNotNil(user.name)
- XCTAssertNotNil(user.username)
- XCTAssertNotNil(user.password)
- XCTAssertEqual(user.name!, User_Tests.name)
- XCTAssertEqual(user.username!, User_Tests.username)
- XCTAssertEqual(user.usernameOrEmail!, User_Tests.username)
- XCTAssertEqual(user.password!, User_Tests.password)
- XCTAssertFalse(user.activated)
- XCTAssertFalse(user.disabled)
- }
-
- func test_USERS_AND_PROPERTIES_NOT_NIL() {
- XCTAssertNotNil(user)
- XCTAssertNotNil(user.name)
- XCTAssertNotNil(user.age)
- XCTAssertNotNil(user.username)
- XCTAssertNotNil(user.email)
- XCTAssertNotNil(user.password)
- XCTAssertNotNil(user.picture)
- XCTAssertNotNil(user.activated)
- XCTAssertNotNil(user.disabled)
- }
-
- func test_USER_PROPERTIES_WITH_HELPERS() {
- user["uuid"] = User_Tests.age
- XCTAssertNil(user.uuid)
-
- XCTAssertEqual(user.name!, User_Tests.name)
- XCTAssertEqual(user.age!, User_Tests.age)
- XCTAssertEqual(user.username!, User_Tests.username)
- XCTAssertEqual(user.email!, User_Tests.email)
- XCTAssertEqual(user.password!, User_Tests.password)
- XCTAssertEqual(user.picture!, User_Tests.picture)
- XCTAssertTrue(user.activated)
- XCTAssertFalse(user.disabled)
- }
-
- func test_USER_PROPERTIES_WITHOUT_HELPERS() {
- XCTAssertEqual(user[UsergridUserProperties.Name.stringValue]! as? String, User_Tests.name)
- XCTAssertEqual(user[UsergridUserProperties.Age.stringValue]! as? Int, User_Tests.age)
- XCTAssertEqual(user[UsergridUserProperties.Username.stringValue]! as? String, User_Tests.username)
- XCTAssertEqual(user[UsergridUserProperties.Email.stringValue]! as? String, User_Tests.email)
- XCTAssertEqual(user[UsergridUserProperties.Password.stringValue]! as? String, User_Tests.password)
- XCTAssertEqual(user[UsergridUserProperties.Picture.stringValue]! as? String, User_Tests.picture)
- XCTAssertTrue(user[UsergridUserProperties.Activated.stringValue]! as! Bool)
- XCTAssertFalse(user[UsergridUserProperties.Disabled.stringValue]! as! Bool)
- }
-
- func deleteUser(expectation:XCTestExpectation) {
- self.user.remove() { removeResponse in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(removeResponse)
- XCTAssertTrue(removeResponse.ok)
- XCTAssertNotNil(removeResponse.user)
- XCTAssertNotNil(removeResponse.users)
- print(removeResponse.error)
- expectation.fulfill()
- }
- }
-
- func test_CREATE_AND_DELETE_USER() {
- let userExpect = self.expectationWithDescription("\(#function)")
-
- user.save() { (createResponse) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(createResponse)
- XCTAssertTrue(createResponse.ok)
- XCTAssertNotNil(createResponse.user)
- XCTAssertNotNil(createResponse.users)
-
- if let createdUser = createResponse.user {
- XCTAssertTrue(createdUser.isUser)
- XCTAssertNotNil(createdUser.uuid)
- XCTAssertNotNil(createdUser.created)
- XCTAssertNotNil(createdUser.modified)
- XCTAssertNotNil(createdUser.location)
- XCTAssertEqual(createdUser.name!, User_Tests.name)
- XCTAssertEqual(createdUser.age!, User_Tests.age)
- XCTAssertEqual(createdUser.username!, User_Tests.username)
- XCTAssertEqual(createdUser.email!, User_Tests.email)
- XCTAssertEqual(createdUser.picture!, User_Tests.picture)
- XCTAssertTrue(createdUser.activated)
- XCTAssertFalse(createdUser.disabled)
- XCTAssertFalse(createdUser.hasAsset)
-
- self.deleteUser(userExpect)
- }
- }
- self.waitForExpectationsWithTimeout(100, handler: nil)
- }
-
- func test_AUTHENTICATE_USER() {
- let userExpect = self.expectationWithDescription("\(#function)")
-
- UsergridUser.checkAvailable(user.email, username: user.username) { error,available in
-
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertTrue(available)
-
- self.user.create() { (createResponse) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(createResponse)
- XCTAssertTrue(createResponse.ok)
- XCTAssertNotNil(createResponse.user)
- XCTAssertNotNil(createResponse.users)
- XCTAssertNotNil(self.user.uuid)
-
- self.user.login(self.user.username!, password:User_Tests.password) { (auth, loggedInUser, error) -> Void in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertNotNil(auth)
- XCTAssertNotNil(loggedInUser)
- XCTAssertEqual(auth, self.user.auth!)
-
- Usergrid.authenticateUser(self.user.auth!) { auth,currentUser,error in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertNotNil(auth)
- XCTAssertEqual(auth, self.user.auth!)
-
- XCTAssertNotNil(currentUser)
- XCTAssertNotNil(Usergrid.currentUser)
- XCTAssertEqual(currentUser, Usergrid.currentUser!)
-
- self.user.reauthenticate() { auth, reauthedUser, error in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertNotNil(auth)
- XCTAssertEqual(auth, self.user.auth!)
-
- XCTAssertNotNil(reauthedUser)
- XCTAssertNotNil(Usergrid.currentUser)
-
- self.user.logout() { response in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(response)
- XCTAssertTrue(response.ok)
- XCTAssertNil(response.error)
-
- self.deleteUser(userExpect)
- }
- }
- }
- }
- }
- }
- self.waitForExpectationsWithTimeout(100, handler: nil)
- }
-
- func test_RESET_USER_PASSWORD() {
- let userExpect = self.expectationWithDescription("\(#function)")
-
- user.create() { (createResponse) in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNotNil(createResponse)
- XCTAssertTrue(createResponse.ok)
- XCTAssertNotNil(createResponse.user)
- XCTAssertNotNil(createResponse.users)
- XCTAssertNotNil(self.user.uuid)
-
- self.user.login(self.user.username!, password:User_Tests.password) { (auth, loggedInUser, error) -> Void in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertNotNil(auth)
- XCTAssertNotNil(loggedInUser)
- XCTAssertEqual(auth, self.user.auth!)
-
- self.user.resetPassword(User_Tests.password, new: User_Tests.resetPassword) { error,didSucceed in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertTrue(didSucceed)
- XCTAssertNil(error)
-
- self.user.login(self.user.username!, password:User_Tests.resetPassword) { (auth, loggedInUser, error) -> Void in
- XCTAssertTrue(NSThread.isMainThread())
- XCTAssertNil(error)
- XCTAssertNotNil(auth)
- XCTAssertNotNil(loggedInUser)
- XCTAssertEqual(auth, self.user.auth!)
-
- self.deleteUser(userExpect)
- }
- }
- }
- }
- self.waitForExpectationsWithTimeout(100, handler: nil)
- }
-
- func test_DEVICE_CONNECTION() {
- let userExpect = self.expectationWithDescription("\(#function)")
-
- user.create() { createResponse in
- XCTAssertNotNil(createResponse)
- XCTAssertTrue(createResponse.ok)
- XCTAssertNotNil(createResponse.user)
- XCTAssertNotNil(createResponse.users)
- XCTAssertNotNil(self.user.uuid)
-
- self.user.connectToDevice() { connectResponse in
- XCTAssertNotNil(connectResponse)
- XCTAssertTrue(connectResponse.ok)
- XCTAssertNil(connectResponse.error)
-
- self.user.getConnectedDevice() { getConnectedDeviceResponse in
- XCTAssertNotNil(getConnectedDeviceResponse)
- XCTAssertTrue(getConnectedDeviceResponse.ok)
- XCTAssertNil(getConnectedDeviceResponse.error)
- XCTAssertNotNil(getConnectedDeviceResponse.entity)
-
- if let responseEntity = getConnectedDeviceResponse.entity {
- XCTAssertTrue(responseEntity is UsergridDevice)
- }
-
- self.user.disconnectFromDevice() { disconnectResponse in
- XCTAssertNotNil(disconnectResponse)
- XCTAssertTrue(disconnectResponse.ok)
- XCTAssertNil(disconnectResponse.error)
-
- self.deleteUser(userExpect)
- }
- }
- }
- }
- self.waitForExpectationsWithTimeout(100, handler: nil)
- }
-
- func test_DEVICE_CONNECT_FAIL() {
- let userExpect = self.expectationWithDescription("\(#function)")
-
- user.create() { createResponse in
- XCTAssertNotNil(createResponse)
- XCTAssertTrue(createResponse.ok)
- XCTAssertNotNil(createResponse.user)
- XCTAssertNotNil(createResponse.users)
- XCTAssertNotNil(self.user.uuid)
-
- self.user.connectToDevice() { connectResponse in
- XCTAssertNotNil(connectResponse)
- XCTAssertTrue(connectResponse.ok)
- XCTAssertNil(connectResponse.error)
-
- self.user.getConnectedDevice() { getConnectedDeviceResponse in
- XCTAssertNotNil(getConnectedDeviceResponse)
- XCTAssertTrue(getConnectedDeviceResponse.ok)
- XCTAssertNil(getConnectedDeviceResponse.error)
- XCTAssertNotNil(getConnectedDeviceResponse.entity)
-
- if let responseEntity = getConnectedDeviceResponse.entity {
- XCTAssertTrue(responseEntity is UsergridDevice)
- }
-
- self.user.disconnectFromDevice() { disconnectResponse in
- XCTAssertNotNil(disconnectResponse)
- XCTAssertTrue(disconnectResponse.ok)
- XCTAssertNil(disconnectResponse.error)
-
- self.deleteUser(userExpect)
- }
- }
- }
- }
- self.waitForExpectationsWithTimeout(100, handler: nil)
- }
-
-
- func test_USER_NSCODING() {
- let userData = NSKeyedArchiver.archivedDataWithRootObject(user)
- let newInstanceFromData = NSKeyedUnarchiver.unarchiveObjectWithData(userData) as? UsergridUser
-
- XCTAssertNotNil(newInstanceFromData)
-
- if let newInstance = newInstanceFromData {
- XCTAssertEqual(user.uuid,newInstance.uuid)
- XCTAssertEqual(user.uuidOrName,newInstance.uuidOrName)
- XCTAssertEqual(user.uuidOrUsername,newInstance.uuidOrUsername)
- XCTAssertEqual(user.auth,newInstance.auth)
- XCTAssertEqual(user.created,newInstance.created)
- XCTAssertEqual(user.modified,newInstance.modified)
- XCTAssertEqual(user.location!.coordinate.longitude,newInstance.location!.coordinate.longitude)
- XCTAssertEqual(user.location!.coordinate.latitude,newInstance.location!.coordinate.latitude)
- XCTAssertEqual(user.name,newInstance.name)
- XCTAssertEqual(user.age,newInstance.age)
- XCTAssertEqual(user.username,newInstance.username)
- XCTAssertEqual(user.email,newInstance.email)
- XCTAssertEqual(user.picture,newInstance.picture)
- XCTAssertEqual(user.activated,newInstance.activated)
- XCTAssertEqual(user.disabled,newInstance.disabled)
- XCTAssertEqual(user.hasAsset,newInstance.hasAsset)
- }
- }
-}
\ No newline at end of file
[13/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser/UsergridUserProperties.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser/UsergridUserProperties.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser/UsergridUserProperties.html
deleted file mode 100644
index e6c7cf6..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser/UsergridUserProperties.html
+++ /dev/null
@@ -1,346 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridUserProperties Enum 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/Enum/UsergridUserProperties" class="dashAnchor"></a>
- <a title="UsergridUserProperties Enum Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../../index.html"> Docs</a> (43% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../../index.html"> Reference</a>
- <img id="carat" src="../../img/carat.png" />
- UsergridUserProperties Enum 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/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/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/UsergridResponse.html">UsergridResponse</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="../../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="../../Extensions/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../../Protocols/UsergridAuth.html">UsergridAuth</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridUserProperties</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties4NameFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Name" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties4NameFMS1_S1_">Name</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8UsernameFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Username" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8UsernameFMS1_S1_">Username</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8PasswordFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Password" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8PasswordFMS1_S1_">Password</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties5EmailFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Email" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties5EmailFMS1_S1_">Email</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties3AgeFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Age" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties3AgeFMS1_S1_">Age</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties9ActivatedFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Activated" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties9ActivatedFMS1_S1_">Activated</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8DisabledFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Disabled" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8DisabledFMS1_S1_">Disabled</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties7PictureFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Picture" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties7PictureFMS1_S1_">Picture</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFOC11UsergridSDK12UsergridUser22UsergridUserProperties10fromStringFMS1_FSSGSqS1__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFOC11UsergridSDK12UsergridUser22UsergridUserProperties10fromStringFMS1_FSSGSqS1__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vOC11UsergridSDK12UsergridUser22UsergridUserProperties11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vOC11UsergridSDK12UsergridUser22UsergridUserProperties11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-20)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/UsergridUserAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html
deleted file mode 100644
index 15b46fb..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html
+++ /dev/null
@@ -1,410 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridUserAuth 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/UsergridUserAuth" class="dashAnchor"></a>
- <a title="UsergridUserAuth 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" />
- UsergridUserAuth 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>UsergridUserAuth</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridUserAuth</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 user 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:vC11UsergridSDK16UsergridUserAuth8usernameSS"></a>
- <a name="//apple_ref/swift/Property/username" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridUserAuth8usernameSS">username</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The username associated with the User.</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">username</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:FC11UsergridSDK16UsergridUserAuthcFT8usernameSS8passwordSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(username:password:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridUserAuthcFT8usernameSS8passwordSS_S0_">init(username:password:)</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/UsergridUserAuth.html">UsergridUserAuth</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">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username associated with the User.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The password associated with the User.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</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:FC11UsergridSDK16UsergridUserAuthcFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridUserAuthcFT5coderCSo7NSCoder_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/UsergridUserAuth.html">UsergridUserAuth</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK16UsergridUserAuth15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridUserAuth15encodeWithCoderFCSo7NSCoderT_">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/Enums.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums.html
deleted file mode 100644
index 56fabb8..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums.html
+++ /dev/null
@@ -1,435 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Enums 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 title="Enums 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" />
- Enums 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>Enums</h1>
- <p>The following enums are available globally.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK16UsergridAuthMode"></a>
- <a name="//apple_ref/swift/Enum/UsergridAuthMode" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK16UsergridAuthMode">UsergridAuthMode</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>An enumeration that is used to determine what the <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> will use for authorization.</p>
-
- <a href="Enums/UsergridAuthMode.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridAuthMode</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK24UsergridEntityProperties"></a>
- <a name="//apple_ref/swift/Enum/UsergridEntityProperties" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK24UsergridEntityProperties">UsergridEntityProperties</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p>
-
- <a href="Enums/UsergridEntityProperties.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridEntityProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK24UsergridDeviceProperties"></a>
- <a name="//apple_ref/swift/Enum/UsergridDeviceProperties" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK24UsergridDeviceProperties">UsergridDeviceProperties</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>UsergridDeviceProperties</code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p>
-
- <a href="Enums/UsergridDeviceProperties.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridDeviceProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK22UsergridUserProperties"></a>
- <a name="//apple_ref/swift/Enum/UsergridUserProperties" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK22UsergridUserProperties">UsergridUserProperties</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Classes/UsergridUser.html">UsergridUser</a></code> specific properties keys.</p>
-
- <a href="Enums/UsergridUserProperties.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridUserProperties</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK21UsergridQueryOperator"></a>
- <a name="//apple_ref/swift/Enum/UsergridQueryOperator" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK21UsergridQueryOperator">UsergridQueryOperator</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Classes/UsergridQuery.html">UsergridQuery</a></code> specific operators.</p>
-
- <a href="Enums/UsergridQueryOperator.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridQueryOperator</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK22UsergridQuerySortOrder"></a>
- <a name="//apple_ref/swift/Enum/UsergridQuerySortOrder" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK22UsergridQuerySortOrder">UsergridQuerySortOrder</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Classes/UsergridQuery.html">UsergridQuery</a></code> specific sort orders.</p>
-
- <a href="Enums/UsergridQuerySortOrder.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridQuerySortOrder</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK24UsergridImageContentType"></a>
- <a name="//apple_ref/swift/Enum/UsergridImageContentType" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK24UsergridImageContentType">UsergridImageContentType</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> image specific content types.</p>
-
- <a href="Enums/UsergridImageContentType.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridImageContentType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK17UsergridDirection"></a>
- <a name="//apple_ref/swift/Enum/UsergridDirection" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK17UsergridDirection">UsergridDirection</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>An enumeration that is used when getting connections to entity objects. Used to determine which the direction of the connection is wanted.</p>
-
- <a href="Enums/UsergridDirection.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridDirection</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:O11UsergridSDK18UsergridHttpMethod"></a>
- <a name="//apple_ref/swift/Enum/UsergridHttpMethod" class="dashAnchor"></a>
- <a class="token" href="#/s:O11UsergridSDK18UsergridHttpMethod">UsergridHttpMethod</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>An enumeration for defining the HTTP methods used by Usergrid.</p>
-
- <a href="Enums/UsergridHttpMethod.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridHttpMethod</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </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/Enums/UsergridAuthFallback.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthFallback.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthFallback.html
deleted file mode 100644
index 13d19bc..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthFallback.html
+++ /dev/null
@@ -1,248 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuthFallback Enum 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/Enum/UsergridAuthFallback" class="dashAnchor"></a>
- <a title="UsergridAuthFallback Enum 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" />
- UsergridAuthFallback Enum 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>UsergridAuthFallback</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridAuthFallback</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p>An enumeration that is used to determine what the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> will fallback to depending on certain authorization conditions.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK20UsergridAuthFallback4NoneFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/None" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK20UsergridAuthFallback4NoneFMS0_S0_">None</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>If a non-expired user auth token exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p>
-
-<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.</p>
-
-<p>If a non-expired user auth token does not exist, all API calls will be made unauthenticated.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">None</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK20UsergridAuthFallback3AppFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/App" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK20UsergridAuthFallback3AppFMS0_S0_">App</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>If a non-expired user auth token exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p>
-
-<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authFallback=.None).</p>
-
-<p>If a non-expired user auth does not exist, all API calls will be made using stored app auth.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">App</span></code></pre>
-
- </div>
- </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 \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/Enums/UsergridAuthMode.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html
deleted file mode 100644
index 7ed672a..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html
+++ /dev/null
@@ -1,283 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuthMode Enum 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/Enum/UsergridAuthMode" class="dashAnchor"></a>
- <a title="UsergridAuthMode Enum 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" />
- UsergridAuthMode Enum 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>UsergridAuthMode</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridAuthMode</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p>An enumeration that is used to determine what the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> will use for authorization.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK16UsergridAuthMode4NoneFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/None" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK16UsergridAuthMode4NoneFMS0_S0_">None</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">None</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK16UsergridAuthMode4UserFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/User" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK16UsergridAuthMode4UserFMS0_S0_">User</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>If a non-expired <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p>
-
-<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">User</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK16UsergridAuthMode3AppFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/App" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK16UsergridAuthMode3AppFMS0_S0_">App</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>If a non-expired <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_">UsergridClient.appAuth</a></code>, this token is used to authenticate all API calls.</p>
-
-<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">App</span></code></pre>
-
- </div>
- </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>
[33/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridResponse.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridResponse.html b/sdks/swift/docs/Classes/UsergridResponse.html
deleted file mode 100644
index 6ff0433..0000000
--- a/sdks/swift/docs/Classes/UsergridResponse.html
+++ /dev/null
@@ -1,969 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridResponse 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/UsergridResponse" class="dashAnchor"></a>
- <a title="UsergridResponse 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" />
- UsergridResponse 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>UsergridResponse</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridResponse</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridResponse</code> is the core class that handles both successful and unsuccessful HTTP responses from Usergrid. </p>
-
-<p>If a request is successful, any entities returned in the response will be automatically parsed into <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects and pushed to the <code>entities</code> property.</p>
-
-<p>If a request fails, the <code>UsergridResponseError.error</code> property will contain information about the problem encountered.</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:vC11UsergridSDK16UsergridResponse6clientXwGSqCS_14UsergridClient_"></a>
- <a name="//apple_ref/swift/Property/client" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse6clientXwGSqCS_14UsergridClient_">client</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 that was responsible for the 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">weak</span> <span class="k">var</span> <span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse12responseJSONGSqGVs10DictionarySSPs9AnyObject___"></a>
- <a name="//apple_ref/swift/Property/responseJSON" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse12responseJSONGSqGVs10DictionarySSPs9AnyObject___">responseJSON</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The raw response JSON.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">responseJSON</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></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse5queryGSqCS_13UsergridQuery_"></a>
- <a name="//apple_ref/swift/Property/query" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5queryGSqCS_13UsergridQuery_">query</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The query used on the 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">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse6cursorGSqSS_"></a>
- <a name="//apple_ref/swift/Property/cursor" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse6cursorGSqSS_">cursor</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The cursor from the response.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">cursor</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:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__"></a>
- <a name="//apple_ref/swift/Property/entities" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The entities created from the response JSON.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">entities</span><span class="p">:</span> <span class="p">[</span><span class="kt">UsergridEntity</span><span class="p">]?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse7headersGSqGVs10DictionarySSSS__"></a>
- <a name="//apple_ref/swift/Property/headers" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse7headersGSqGVs10DictionarySSSS__">headers</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The response headers.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">headers</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</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:vC11UsergridSDK16UsergridResponse10statusCodeGSqSi_"></a>
- <a name="//apple_ref/swift/Property/statusCode" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse10statusCodeGSqSi_">statusCode</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The response status code.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">statusCode</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse5errorGSqCS_21UsergridResponseError_"></a>
- <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5errorGSqCS_21UsergridResponseError_">error</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The error object containing error information if one occurred.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse2okSb"></a>
- <a name="//apple_ref/swift/Property/ok" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse2okSb">ok</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns true if the HTTP status code from the response is less than 400.</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">ok</span> <span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse5countSi"></a>
- <a name="//apple_ref/swift/Property/count" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5countSi">count</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The count of <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</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">count</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">entities</span><span class="p">?</span><span class="o">.</span><span class="n">count</span> <span class="p">??</span> <span class="mi">0</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse5firstGSqCS_14UsergridEntity_"></a>
- <a name="//apple_ref/swift/Property/first" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5firstGSqCS_14UsergridEntity_">first</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The first entity in <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</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">first</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span><span class="p">?</span><span class="o">.</span><span class="n">first</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse4lastGSqCS_14UsergridEntity_"></a>
- <a name="//apple_ref/swift/Property/last" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse4lastGSqCS_14UsergridEntity_">last</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The last entity in <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</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">last</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span><span class="p">?</span><span class="o">.</span><span class="n">last</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse6entityGSqCS_14UsergridEntity_"></a>
- <a name="//apple_ref/swift/Property/entity" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse6entityGSqCS_14UsergridEntity_">entity</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The first entity in <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</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">entity</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">first</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse4userGSqCS_12UsergridUser_"></a>
- <a name="//apple_ref/swift/Property/user" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse4userGSqCS_12UsergridUser_">user</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> entity.</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">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span><span class="p">?</span><span class="o">.</span><span class="n">first</span> <span class="k">as?</span> <span class="kt">UsergridUser</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse5usersGSqGSaCS_12UsergridUser__"></a>
- <a name="//apple_ref/swift/Property/users" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5usersGSqGSaCS_12UsergridUser__">users</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>An array of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> entities.</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">users</span><span class="p">:</span> <span class="p">[</span><span class="kt">UsergridUser</span><span class="p">]?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span> <span class="k">as?</span> <span class="p">[</span><span class="kt">UsergridUser</span><span class="p">]</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse11hasNextPageSb"></a>
- <a name="//apple_ref/swift/Property/hasNextPage" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse11hasNextPageSb">hasNextPage</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Does the response have a cursor.</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">hasNextPage</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">cursor</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK16UsergridResponse11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The string value.</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">stringValue</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:vC11UsergridSDK16UsergridResponse11descriptionSS"></a>
- <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse11descriptionSS">description</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The description.</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">override</span> <span class="k">var</span> <span class="nv">description</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:vC11UsergridSDK16UsergridResponse16debugDescriptionSS"></a>
- <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse16debugDescriptionSS">debugDescription</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The debug description.</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">override</span> <span class="k">var</span> <span class="nv">debugDescription</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:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_9errorNameSS16errorDescriptionSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(client:errorName:errorDescription:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_9errorNameSS16errorDescriptionSS_S0_">init(client:errorName:errorDescription:)</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/UsergridResponse.html">UsergridResponse</a></code> objects that contain errors.</p>
-
-<p>These types of responses are usually created because request conditions are not met.</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">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">?,</span> <span class="nv">errorName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">errorDescription</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client responsible for the request.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>errorName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The error name.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>errorDescription</em>
- </code>
- </td>
- <td>
- <div>
- <p>The error description.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridResponse.html">UsergridResponse</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_4dataGSqCSo6NSData_8responseGSqCSo17NSHTTPURLResponse_5errorGSqCSo7NSError_5queryGSqCS_13UsergridQuery__S0_"></a>
- <a name="//apple_ref/swift/Method/init(client:data:response:error:query:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_4dataGSqCSo6NSData_8responseGSqCSo17NSHTTPURLResponse_5errorGSqCSo7NSError_5queryGSqCS_13UsergridQuery__S0_">init(client:data:response:error:query:)</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/UsergridResponse.html">UsergridResponse</a></code> objects finished but still may contain errors.</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">client</span><span class="p">:</span><span class="kt">UsergridClient</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">response</span><span class="p">:</span><span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span><span class="kt">NSError</span><span class="p">?,</span> <span class="nv">query</span><span class="p">:</span><span class="kt">UsergridQuery</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client responsible for the request.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>data</em>
- </code>
- </td>
- <td>
- <div>
- <p>The response data.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>response</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>NSHTTPURLResponse</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>error</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>NSError</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>query</em>
- </code>
- </td>
- <td>
- <div>
- <p>The query when making the request.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridResponse.html">UsergridResponse</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Instance%20Methods"></a>
- <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
- <a href="#/Instance%20Methods">
- <h3 class="section-name">Instance Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK16UsergridResponse12loadNextPageFFT8responseS0__T_T_"></a>
- <a name="//apple_ref/swift/Method/loadNextPage(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK16UsergridResponse12loadNextPageFFT8responseS0__T_T_">loadNextPage(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Attempts to load the next page of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects. </p>
-
-<p>This requires a <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse6cursorGSqSS_">cursor</a></code> to be valid as well as a <code>path</code> key within the response JSON.</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">loadNextPage</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that is called once the request for the next page has finished.</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/Classes/UsergridResponseError.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridResponseError.html b/sdks/swift/docs/Classes/UsergridResponseError.html
deleted file mode 100644
index 46fd05a..0000000
--- a/sdks/swift/docs/Classes/UsergridResponseError.html
+++ /dev/null
@@ -1,473 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridResponseError 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/UsergridResponseError" class="dashAnchor"></a>
- <a title="UsergridResponseError 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" />
- UsergridResponseError 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>UsergridResponseError</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridResponseError</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p>A standard error object that contains details about a request failure.</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:vC11UsergridSDK21UsergridResponseError9errorNameSS"></a>
- <a name="//apple_ref/swift/Property/errorName" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK21UsergridResponseError9errorNameSS">errorName</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The error’s name.</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">errorName</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:vC11UsergridSDK21UsergridResponseError16errorDescriptionSS"></a>
- <a name="//apple_ref/swift/Property/errorDescription" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK21UsergridResponseError16errorDescriptionSS">errorDescription</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The error’s description.</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">errorDescription</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:vC11UsergridSDK21UsergridResponseError9exceptionGSqSS_"></a>
- <a name="//apple_ref/swift/Property/exception" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK21UsergridResponseError9exceptionGSqSS_">exception</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The exception.</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">exception</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:vC11UsergridSDK21UsergridResponseError11descriptionSS"></a>
- <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK21UsergridResponseError11descriptionSS">description</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The description.</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">override</span> <span class="k">var</span> <span class="nv">description</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:vC11UsergridSDK21UsergridResponseError16debugDescriptionSS"></a>
- <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK21UsergridResponseError16debugDescriptionSS">debugDescription</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The debug description.</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">override</span> <span class="k">var</span> <span class="nv">debugDescription</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:FC11UsergridSDK21UsergridResponseErrorcFT9errorNameSS16errorDescriptionSS9exceptionGSqSS__S0_"></a>
- <a name="//apple_ref/swift/Method/init(errorName:errorDescription:exception:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK21UsergridResponseErrorcFT9errorNameSS16errorDescriptionSS9exceptionGSqSS__S0_">init(errorName:errorDescription:exception:)</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/UsergridResponseError.html">UsergridResponseError</a></code>.</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">errorName</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">errorDescription</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">exception</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>errorName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The error’s name.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>errorDescription</em>
- </code>
- </td>
- <td>
- <div>
- <p>The error’s description.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>exception</em>
- </code>
- </td>
- <td>
- <div>
- <p>The exception.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridResponseError.html">UsergridResponseError</a></code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK21UsergridResponseErrorcFT14jsonDictionaryGVs10DictionarySSPs9AnyObject___GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(jsonDictionary:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK21UsergridResponseErrorcFT14jsonDictionaryGVs10DictionarySSPs9AnyObject___GSqS0__">init(jsonDictionary:)</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/UsergridResponseError.html">UsergridResponseError</a></code> that determines if the given <code>jsonDictionary</code> contains an error.</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">jsonDictionary</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">])</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>jsonDictionary</em>
- </code>
- </td>
- <td>
- <div>
- <p>The JSON dictionary that may contain error information.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridResponseError.html">UsergridResponseError</a></code> if the JSON dictionary did indeed contain error information.</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>
[02/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
deleted file mode 100644
index 9db7a66..0000000
--- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
+++ /dev/null
@@ -1,550 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuth 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/UsergridAuth" class="dashAnchor"></a>
- <a title="UsergridAuth 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" />
- UsergridAuth 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>UsergridAuth</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p>The <code>UsergridAuth</code> class functions to create and store authentication information used by Usergrid.</p>
-
-<p>The <code>UsergridAuth</code> sub classes, <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> and <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code>, provide different ways for authentication to be used in creating requests for access tokens through the SDK.</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:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_"></a>
- <a name="//apple_ref/swift/Property/accessToken" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The access token, if this <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> was authorized successfully.</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">accessToken</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:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_"></a>
- <a name="//apple_ref/swift/Property/expiry" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_">expiry</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The expires at date, if this <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> was authorized successfully and their was a expires in time stamp within the token response.</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">expiry</span> <span class="p">:</span> <span class="kt">NSDate</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridAuth8hasTokenSb"></a>
- <a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth8hasTokenSb">hasToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if an access token exists.</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">hasToken</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">accessToken</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridAuth7isValidSb"></a>
- <a name="//apple_ref/swift/Property/isValid" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth7isValidSb">isValid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if an access token exists and if the token is not expired.</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">isValid</span> <span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">hasToken</span> <span class="o">&&</span> <span class="o">!</span><span class="k">self</span><span class="o">.</span><span class="n">isExpired</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridAuth9isExpiredSb"></a>
- <a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth9isExpiredSb">isExpired</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if the access token, if one exists, is expired.</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">isExpired</span><span class="p">:</span> <span class="kt">Bool</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:FC11UsergridSDK12UsergridAuthcFMS0_FT11accessTokenSS6expiryGSqCSo6NSDate__S0_"></a>
- <a name="//apple_ref/swift/Method/init(accessToken:expiry:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFMS0_FT11accessTokenSS6expiryGSqCSo6NSDate__S0_">init(accessToken:expiry:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializer for a base <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object that just contains an <code><a href="../Classes/UsergridAuth.html#/s:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a></code> and an optional <code><a href="../Classes/UsergridAuth.html#/s:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_">expiry</a></code> date.</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">accessToken</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">expiry</span><span class="p">:</span><span class="kt">NSDate</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>accessToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The access token.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>expiry</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional expiry date.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridAuth.html">UsergridAuth</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:FC11UsergridSDK12UsergridAuthcFMS0_FT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFMS0_FT5coderCSo7NSCoder_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:FC11UsergridSDK12UsergridAuth15encodeWithCoderFS0_FCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuth15encodeWithCoderFS0_FCSo7NSCoderT_">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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Instance%20Methods"></a>
- <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
- <a href="#/Instance%20Methods">
- <h3 class="section-name">Instance Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridAuth7destroyFS0_FT_T_"></a>
- <a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuth7destroyFS0_FT_T_">destroy()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Destroys/removes the access token and expiry.</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">destroy</span><span class="p">()</span></code></pre>
-
- </div>
- </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 \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>
[38/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridClientConfig.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridClientConfig.html b/sdks/swift/docs/Classes/UsergridClientConfig.html
deleted file mode 100644
index b7abeab..0000000
--- a/sdks/swift/docs/Classes/UsergridClientConfig.html
+++ /dev/null
@@ -1,744 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridClientConfig 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/UsergridClientConfig" class="dashAnchor"></a>
- <a title="UsergridClientConfig 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" />
- UsergridClientConfig 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>UsergridClientConfig</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClientConfig</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridClientConfig</code> is used when initializing <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> objects.</p>
-
-<p>The <code>UsergridClientConfig</code> is meant for further customization of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> objects when needed.</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:vC11UsergridSDK20UsergridClientConfig5orgIdSS"></a>
- <a name="//apple_ref/swift/Property/orgId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig5orgIdSS">orgId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The organization identifier.</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">orgId</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:vC11UsergridSDK20UsergridClientConfig5appIdSS"></a>
- <a name="//apple_ref/swift/Property/appId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig5appIdSS">appId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application identifier.</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">appId</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:vC11UsergridSDK20UsergridClientConfig7baseUrlSS"></a>
- <a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig7baseUrlSS">baseUrl</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The base URL that all calls will be made with.</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">baseUrl</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt">UsergridClient</span><span class="o">.</span><span class="kt">DEFAULT_BASE_URL</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK20UsergridClientConfig8authModeOS_16UsergridAuthMode"></a>
- <a name="//apple_ref/swift/Property/authMode" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig8authModeOS_16UsergridAuthMode">authMode</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent, if any.</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">authMode</span><span class="p">:</span> <span class="kt">UsergridAuthMode</span> <span class="o">=</span> <span class="o">.</span><span class="kt">User</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK20UsergridClientConfig28persistCurrentUserInKeychainSb"></a>
- <a name="//apple_ref/swift/Property/persistCurrentUserInKeychain" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Whether or not the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> current user will be saved and restored from the keychain.</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">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK20UsergridClientConfig7appAuthGSqCS_15UsergridAppAuth_"></a>
- <a name="//apple_ref/swift/Property/appAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridClientConfig7appAuthGSqCS_15UsergridAppAuth_">appAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application level <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object.</p>
-
-<p>Note that you still need to call the authentication methods within <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> once it has been initialized.</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">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</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:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS_S0_">init(orgId:appId:)</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/UsergridClientConfig.html">UsergridClientConfig</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</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>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:baseUrl:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS_S0_">init(orgId:appId:baseUrl:)</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/UsergridClientConfig.html">UsergridClientConfig</a></code>.</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">baseUrl</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>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>baseUrl</em>
- </code>
- </td>
- <td>
- <div>
- <p>The base URL that all calls will be made with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS8authModeOS_16UsergridAuthMode28persistCurrentUserInKeychainSb7appAuthGSqCS_15UsergridAppAuth__S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:baseUrl:authMode:persistCurrentUserInKeychain:appAuth:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5orgIdSS5appIdSS7baseUrlSS8authModeOS_16UsergridAuthMode28persistCurrentUserInKeychainSb7appAuthGSqCS_15UsergridAppAuth__S0_">init(orgId:appId:baseUrl:authMode:persistCurrentUserInKeychain:appAuth:)</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/UsergridClientConfig.html">UsergridClientConfig</a></code>.</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</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">authMode</span><span class="p">:</span><span class="kt">UsergridAuthMode</span><span class="p">,</span> <span class="nv">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">appAuth</span><span class="p">:</span><span class="kt">UsergridAppAuth</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</s
pan></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>baseUrl</em>
- </code>
- </td>
- <td>
- <div>
- <p>The base URL that all calls will be made with.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>authMode</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAuthMode</code> value used to determine what type of token will be sent, if any.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>persistCurrentUserInKeychain</em>
- </code>
- </td>
- <td>
- <div>
- <p>Whether or not the <code>UsergridClient</code> current user will be saved and restored from the keychain.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appAuth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application level <code>UsergridAppAuth</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</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:FC11UsergridSDK20UsergridClientConfigcFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfigcFT5coderCSo7NSCoder_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">public</span> <span class="kd">required</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:FC11UsergridSDK20UsergridClientConfig15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridClientConfig15encodeWithCoderFCSo7NSCoderT_">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/Classes/UsergridDevice.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridDevice.html b/sdks/swift/docs/Classes/UsergridDevice.html
deleted file mode 100644
index 9cda8aa..0000000
--- a/sdks/swift/docs/Classes/UsergridDevice.html
+++ /dev/null
@@ -1,763 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridDevice 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/UsergridDevice" class="dashAnchor"></a>
- <a title="UsergridDevice 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" />
- UsergridDevice 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>UsergridDevice</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridDevice</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridDevice</code> is an <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> subclass that encapsulates information about the current device as well as stores information about push tokens and Usergrid notifiers.</p>
-
-<p>To apply push tokens for Usergrid notifiers use the <code>UsergridClient.applyPushToken</code> method.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:iC11UsergridSDK14UsergridDevice9subscriptFSSGSqPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:iC11UsergridSDK14UsergridDevice9subscriptFSSGSqPs9AnyObject__">subscript(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Subscript for the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> class. Note that all of the <code><a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a></code> are immutable.</p>
-
-<div class="aside aside-warning">
- <p class="aside-title">Warning</p>
- <p>When setting a properties value must be a valid JSON object.</p>
-
-</div>
-
-<p><li><p>Example usage:
-<code>
-let uuid = usergridDevice["uuid"]
-</code></p></li></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="nf">subscript</span><span class="p">(</span><span class="nv">propertyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AnyObject</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="/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:vC11UsergridSDK14UsergridDevice5modelSS"></a>
- <a name="//apple_ref/swift/Property/model" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridDevice5modelSS">model</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> objects device model.</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">model</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">super</span><span class="p">[</span><span class="kt">UsergridDeviceProperties</span><span class="o">.</span><span class="kt">Model</span><span class="o">.</span><span class="n">stringValue</span><span class="p">]</span> <span class="k">as!</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:vC11UsergridSDK14UsergridDevice8platformSS"></a>
- <a name="//apple_ref/swift/Property/platform" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridDevice8platformSS">platform</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> objects device platform.</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">platform</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">super</span><span class="p">[</span><span class="kt">UsergridDeviceProperties</span><span class="o">.</span><span class="kt">Platform</span><span class="o">.</span><span class="n">stringValue</span><span class="p">]</span> <span class="k">as!</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:vC11UsergridSDK14UsergridDevice9osVersionSS"></a>
- <a name="//apple_ref/swift/Property/osVersion" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridDevice9osVersionSS">osVersion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Property helper method for the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> objects device operating system version.</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">osVersion</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="k">super</span><span class="p">[</span><span class="kt">UsergridDeviceProperties</span><span class="o">.</span><span class="kt">OSVersion</span><span class="o">.</span><span class="n">stringValue</span><span class="p">]</span> <span class="k">as!</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:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_"></a>
- <a name="//apple_ref/swift/Variable/sharedDevice" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">sharedDevice</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The shared instance of <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">sharedDevice</span><span class="p">:</span> <span class="kt">UsergridDevice</span> <span class="o">=</span> <span class="kt">UsergridDevice</span><span class="o">.</span><span class="nf">getOrCreateSharedDeviceFromKeychain</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:FC11UsergridSDK14UsergridDevicecFT_S0_"></a>
- <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevicecFT_S0_">init()</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/UsergridDevice.html">UsergridDevice</a></code> objects</p>
-
-<p>Most likely you will never need to create seperate instances of <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code>. Use of <code>UsergridDevice.sharedInstance</code> is recommended.</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></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridDevicecFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a>
- <a name="//apple_ref/swift/Method/init(type:name:propertyDict:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevicecFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_">init(type:name:propertyDict:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The required public initializer for <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> subclasses.</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="nv">type</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">propertyDict</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></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The type associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional name associated with the <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>propertyDict</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional property dictionary that the <code>UsergridEntity</code> object will start out with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> object.</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:FC11UsergridSDK14UsergridDevicecFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevicecFT5coderCSo7NSCoder_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:FC11UsergridSDK14UsergridDevice15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevice15encodeWithCoderFCSo7NSCoderT_">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="k">override</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>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridDevice4saveFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/save(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevice4saveFTGSqFT8responseCS_16UsergridResponse_T___T_">save(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a PUT (or POST if no UUID is found) on the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
-<p>If this device is equal to <code><a href="../Classes/UsergridDevice.html#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">UsergridDevice.sharedDevice</a></code> it will also update the shared device on the keychain.</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">override</span> <span class="kd">func</span> <span class="nf">save</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the updated/saved <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridDevice4saveFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/save(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridDevice4saveFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">save(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Performs a PUT (or POST if no UUID is found) on the <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code>.</p>
-
-<p>If this device is equal to <code><a href="../Classes/UsergridDevice.html#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">UsergridDevice.sharedDevice</a></code> it will also update the shared device on the keychain.</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">override</span> <span class="kd">func</span> <span class="nf">save</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>client</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client to use when saving.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional completion block that, if successful, will contain the updated/saved <code>UsergridEntity</code> object.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK14UsergridDevice26saveSharedDeviceToKeychainFT_T_"></a>
- <a name="//apple_ref/swift/Method/saveSharedDeviceToKeychain()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK14UsergridDevice26saveSharedDeviceToKeychainFT_T_">saveSharedDeviceToKeychain()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Saves the <code><a href="../Classes/UsergridDevice.html#/s:ZvC11UsergridSDK14UsergridDevice12sharedDeviceS0_">UsergridDevice.sharedDevice</a></code> to the keychain.</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">static</span> <span class="kd">func</span> <span class="nf">saveSharedDeviceToKeychain</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="/Class%20Helper%20Methods"></a>
- <a name="//apple_ref/swift/Section/Class Helper Methods" class="dashAnchor"></a>
- <a href="#/Class%20Helper%20Methods">
- <h3 class="section-name">Class Helper Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK14UsergridDevice24commonDevicePropertyDictFT_GVs10DictionarySSPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Method/commonDevicePropertyDict()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK14UsergridDevice24commonDevicePropertyDictFT_GVs10DictionarySSPs9AnyObject__">commonDevicePropertyDict()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a property dictionary that contains the common properties for <code><a href="../Classes/UsergridDevice.html">UsergridDevice</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="kd">static</span> <span class="kd">func</span> <span class="nf">commonDevicePropertyDict</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">]</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A property dictionary with the common properties set.</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>
[28/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Extensions/NSDate.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Extensions/NSDate.html b/sdks/swift/docs/Extensions/NSDate.html
deleted file mode 100644
index e69c6e3..0000000
--- a/sdks/swift/docs/Extensions/NSDate.html
+++ /dev/null
@@ -1,448 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>NSDate Extension 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/Extension/NSDate" class="dashAnchor"></a>
- <a title="NSDate Extension 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" />
- NSDate Extension 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>NSDate</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FE11UsergridSDKCSo6NSDatecFT12millisecondsSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(milliseconds:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FE11UsergridSDKCSo6NSDatecFT12millisecondsSS_S0_">init(milliseconds:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a new <code><a href="../Extensions/NSDate.html">NSDate</a></code> object with the given milliseconds.</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">milliseconds</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>milliseconds</em>
- </code>
- </td>
- <td>
- <div>
- <p>the milliseconds</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new <code><a href="../Extensions/NSDate.html">NSDate</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FE11UsergridSDKCSo6NSDate18dateAsMillisecondsFT_Si"></a>
- <a name="//apple_ref/swift/Method/dateAsMilliseconds()" class="dashAnchor"></a>
- <a class="token" href="#/s:FE11UsergridSDKCSo6NSDate18dateAsMillisecondsFT_Si">dateAsMilliseconds()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to milliseconds.</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">dateAsMilliseconds</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The number of milliseconds corresponding to the date.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FE11UsergridSDKCSo6NSDate24dateAsMillisecondsStringFT_SS"></a>
- <a name="//apple_ref/swift/Method/dateAsMillisecondsString()" class="dashAnchor"></a>
- <a class="token" href="#/s:FE11UsergridSDKCSo6NSDate24dateAsMillisecondsStringFT_SS">dateAsMillisecondsString()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to milliseconds and returns the value as a string.</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">dateAsMillisecondsString</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The number of milliseconds corresponding to the date as a string.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFE11UsergridSDKCSo6NSDate22stringFromMillesecondsFSiSS"></a>
- <a name="//apple_ref/swift/Method/stringFromMilleseconds(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate22stringFromMillesecondsFSiSS">stringFromMilleseconds(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the number of milliseconds to a string.</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">static</span> <span class="kd">func</span> <span class="nf">stringFromMilleseconds</span><span class="p">(</span><span class="nv">milliseconds</span><span class="p">:</span><span class="kt">Int</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>milliseconds</em>
- </code>
- </td>
- <td>
- <div>
- <p>the milliseconds to convert</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The milliseconds as a string.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFE11UsergridSDKCSo6NSDate19unixTimeStampStringFT_SS"></a>
- <a name="//apple_ref/swift/Method/unixTimeStampString()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate19unixTimeStampStringFT_SS">unixTimeStampString()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to the corresponding UNIX time stamp as a string.</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">static</span> <span class="kd">func</span> <span class="nf">unixTimeStampString</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The UNIX time stamp as a string.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFE11UsergridSDKCSo6NSDate13unixTimeStampFT_Si"></a>
- <a name="//apple_ref/swift/Method/unixTimeStamp()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate13unixTimeStampFT_Si">unixTimeStamp()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to the corresponding UNIX time stamp.</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">static</span> <span class="kd">func</span> <span class="nf">unixTimeStamp</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The UNIX time stamp.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFE11UsergridSDKCSo6NSDate17nowAsMillisecondsFT_Si"></a>
- <a name="//apple_ref/swift/Method/nowAsMilliseconds()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate17nowAsMillisecondsFT_Si">nowAsMilliseconds()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the current date to milliseconds.</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">static</span> <span class="kd">func</span> <span class="nf">nowAsMilliseconds</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The milliseconds of the current date.</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>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Extensions/UsergridAsset.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Extensions/UsergridAsset.html b/sdks/swift/docs/Extensions/UsergridAsset.html
deleted file mode 100644
index e570062..0000000
--- a/sdks/swift/docs/Extensions/UsergridAsset.html
+++ /dev/null
@@ -1,184 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAsset Extension 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/Extension/UsergridAsset" class="dashAnchor"></a>
- <a title="UsergridAsset Extension Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html"> Docs</a></p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> Reference</a>
- <img id="carat" src="../img/carat.png" />
- UsergridAsset Extension 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/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/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/UsergridResponse.html">UsergridResponse</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="../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridAsset.html">UsergridAsset</a>
- </li>
- <li class="nav-group-task">
- <a href="../Extensions/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="../Extensions/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Protocols/UsergridAuth.html">UsergridAuth</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridAsset</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK13UsergridAsset17multiPartHTTPBodyCSo6NSData"></a>
- <a name="//apple_ref/swift/Property/multiPartHTTPBody" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset17multiPartHTTPBodyCSo6NSData">multiPartHTTPBody</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridAsset16multipartRequestFS0_FCSo5NSURLCSo19NSMutableURLRequest"></a>
- <a name="//apple_ref/swift/Method/multipartRequest(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAsset16multipartRequestFS0_FCSo5NSURLCSo19NSMutableURLRequest">multipartRequest(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridAsset23multipartRequestAndBodyFS0_FCSo5NSURLT7requestCSo19NSMutableURLRequest13multipartDataCSo6NSData_"></a>
- <a name="//apple_ref/swift/Method/multipartRequestAndBody(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAsset23multipartRequestAndBodyFS0_FCSo5NSURLT7requestCSo19NSMutableURLRequest13multipartDataCSo6NSData_">multipartRequestAndBody(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-20)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/Extensions/UsergridAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Extensions/UsergridAuth.html b/sdks/swift/docs/Extensions/UsergridAuth.html
deleted file mode 100644
index ff7b963..0000000
--- a/sdks/swift/docs/Extensions/UsergridAuth.html
+++ /dev/null
@@ -1,260 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuth Extension 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/Extension/UsergridAuth" class="dashAnchor"></a>
- <a title="UsergridAuth Extension Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html"> Docs</a> (46% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> Reference</a>
- <img id="carat" src="../img/carat.png" />
- UsergridAuth Extension 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/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/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/UsergridResponse.html">UsergridResponse</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="../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="../Extensions/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Protocols/UsergridAuth.html">UsergridAuth</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridAuth</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:veRq_11UsergridSDK12UsergridAuth_S_S0_8hasTokenSb"></a>
- <a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a>
- <a class="token" href="#/s:veRq_11UsergridSDK12UsergridAuth_S_S0_8hasTokenSb">hasToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if an access token exists.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">hasToken</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">accessToken</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:veRq_11UsergridSDK12UsergridAuth_S_S0_12tokenIsValidSb"></a>
- <a name="//apple_ref/swift/Property/tokenIsValid" class="dashAnchor"></a>
- <a class="token" href="#/s:veRq_11UsergridSDK12UsergridAuth_S_S0_12tokenIsValidSb">tokenIsValid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if an access token exists and if the token is not expired.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">tokenIsValid</span> <span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">hasToken</span> <span class="o">&&</span> <span class="o">!</span><span class="k">self</span><span class="o">.</span><span class="n">isExpired</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:veRq_11UsergridSDK12UsergridAuth_S_S0_9isExpiredSb"></a>
- <a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a>
- <a class="token" href="#/s:veRq_11UsergridSDK12UsergridAuth_S_S0_9isExpiredSb">isExpired</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if the access token, if one exists, is expired.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isExpired</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FeRq_11UsergridSDK12UsergridAuth_S_S0_16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest"></a>
- <a name="//apple_ref/swift/Method/buildAuthRequest(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FeRq_11UsergridSDK12UsergridAuth_S_S0_16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest">buildAuthRequest(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Builds an authorization request which is can be used to retrieve the access token.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">buildAuthRequest</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="o">-></span> <span class="kt">NSURLRequest</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 of the access token request.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A <code>NSURLRequest</code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-21)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
- </section>
- </article>
- </div>
- </body>
-</div>
-</html>
[03/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html
deleted file mode 100644
index 3e5118a..0000000
--- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html
+++ /dev/null
@@ -1,402 +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">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" />
- 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/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>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:FC11UsergridSDK15UsergridAppAuthcFMS0_FT8clientIdSS12clientSecretSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(clientId:clientSecret:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuthcFMS0_FT8clientIdSS12clientSecretSS_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:FC11UsergridSDK15UsergridAppAuthcFMS0_FT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuthcFMS0_FT5coderCSo7NSCoder_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:FC11UsergridSDK15UsergridAppAuth15encodeWithCoderFS0_FCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuth15encodeWithCoderFS0_FCSo7NSCoderT_">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="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 \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/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html
deleted file mode 100644
index b473cd1..0000000
--- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html
+++ /dev/null
@@ -1,694 +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">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" />
- 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/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>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:FC11UsergridSDK13UsergridAssetcFMS0_FT8filenameGSqSS_4dataCSo6NSData16originalLocationGSqSS_11contentTypeSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(filename:data:originalLocation:contentType:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFMS0_FT8filenameGSqSS_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:FC11UsergridSDK13UsergridAssetcFMS0_FT8fileNameGSqSS_5imageCSo7UIImage16imageContentTypeOS_24UsergridImageContentType_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(fileName:image:imageContentType:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFMS0_FT8fileNameGSqSS_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:FC11UsergridSDK13UsergridAssetcFMS0_FT8fileNameGSqSS_7fileURLCSo5NSURL11contentTypeGSqSS__GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(fileName:fileURL:contentType:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFMS0_FT8fileNameGSqSS_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:FC11UsergridSDK13UsergridAssetcFMS0_FT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFMS0_FT5coderCSo7NSCoder_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:FC11UsergridSDK13UsergridAsset15encodeWithCoderFS0_FCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAsset15encodeWithCoderFS0_FCSo7NSCoderT_">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="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 \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/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html
deleted file mode 100644
index 393f872..0000000
--- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html
+++ /dev/null
@@ -1,348 +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">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 \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>
[21/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClient.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClient.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClient.html
deleted file mode 100644
index 09c2175..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClient.html
+++ /dev/null
@@ -1,3873 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridClient 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/UsergridClient" class="dashAnchor"></a>
- <a title="UsergridClient 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" />
- UsergridClient 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>UsergridClient</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p>The <code>UsergridClient</code> class is the base handler for making client connections to and managing relationships with Usergrid’s API.</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:vC11UsergridSDK14UsergridClient6configCS_20UsergridClientConfig"></a>
- <a name="//apple_ref/swift/Property/config" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient6configCS_20UsergridClientConfig">config</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The configuration object used by the client.</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">config</span><span class="p">:</span> <span class="kt">UsergridClientConfig</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient5appIdSS"></a>
- <a name="//apple_ref/swift/Property/appId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient5appIdSS">appId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application identifier.</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">appId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">appId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient5orgIdSS"></a>
- <a name="//apple_ref/swift/Property/orgId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient5orgIdSS">orgId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The organization identifier.</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">orgId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">orgId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient7baseUrlSS"></a>
- <a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient7baseUrlSS">baseUrl</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The base URL that all calls will be made with.</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">baseUrl</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">baseUrl</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient12clientAppURLSS"></a>
- <a name="//apple_ref/swift/Property/clientAppURL" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient12clientAppURLSS">clientAppURL</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The constructed URL string based on the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient7baseUrlSS">baseUrl</a></code>, <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient5orgIdSS">orgId</a></code>, and <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient5appIdSS">appId</a></code>.</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">clientAppURL</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="s">"</span><span class="se">\(</span><span class="n">baseUrl</span><span class="se">)</span><span class="s">/</span><span class="se">\(</span><span class="n">orgId</span><span class="se">)</span><span class="s">/</span><span class="se">\(</span><span class="n">appId</span><span class="se">)</span><span class="s">"</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient28persistCurrentUserInKeychainSb"></a>
- <a name="//apple_ref/swift/Property/persistCurrentUserInKeychain" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Whether or not the current user will be saved and restored from the keychain.</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">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_"></a>
- <a name="//apple_ref/swift/Property/currentUser" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">currentUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The currently logged in <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">currentUser</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient8userAuthGSqCS_16UsergridUserAuth_"></a>
- <a name="//apple_ref/swift/Property/userAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient8userAuthGSqCS_16UsergridUserAuth_">userAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> which consists of the token information from the <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">currentUser</a></code> property.</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">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">currentUser</span><span class="p">?</span><span class="o">.</span><span class="n">auth</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_"></a>
- <a name="//apple_ref/swift/Property/appAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_">appAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application level <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object. Can be set manually but must call <code>authenticateApp</code> to retrive token.</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">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode"></a>
- <a name="//apple_ref/swift/Property/authMode" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode">authMode</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent, if any.</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">authMode</span><span class="p">:</span> <span class="kt">UsergridAuthMode</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:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS_S0_">init(orgId:appId:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes instances of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</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>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS7baseUrlSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(orgId:appId:baseUrl:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS7baseUrlSS_S0_">init(orgId:appId:baseUrl:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes instances of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">baseUrl</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>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>baseUrl</em>
- </code>
- </td>
- <td>
- <div>
- <p>The base URL that all calls will be made with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClientcFT13configurationCS_20UsergridClientConfig_S0_"></a>
- <a name="//apple_ref/swift/Method/init(configuration:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT13configurationCS_20UsergridClientConfig_S0_">init(configuration:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes instances of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">configuration</span><span class="p">:</span><span class="kt">UsergridClientConfig</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>configuration</em>
- </code>
- </td>
- <td>
- <div>
- <p>The configuration for the client to be set up with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</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:FC11UsergridSDK14UsergridClientcFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT5coderCSo7NSCoder_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">public</span> <span class="kd">required</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/UsergridClient.html">UsergridClient</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15encodeWithCoderFCSo7NSCoderT_">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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Device%20Registration/Push%20Notifications"></a>
- <a name="//apple_ref/swift/Section/Device Registration/Push Notifications" class="dashAnchor"></a>
- <a href="#/Device%20Registration/Push%20Notifications">
- <h3 class="section-name">Device Registration/Push Notifications</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the shared <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance.</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">applyPushToken</span><span class="p">(</span><span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:pushToken:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:pushToken:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the given <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance.</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">applyPushToken</span><span class="p">(</span><span class="nv">device</span><span class="p">:</span> <span class="kt">UsergridDevice</span><span class="p">,</span> <span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>device</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridDevice</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Authorization%20and%20User%20Management"></a>
- <a name="//apple_ref/swift/Section/Authorization and User Management" class="dashAnchor"></a>
- <a href="#/Authorization%20and%20User%20Management">
- <h3 class="section-name">Authorization and User Management</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authForRequestsFT_GSqCS_12UsergridAuth_"></a>
- <a name="//apple_ref/swift/Method/authForRequests()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authForRequestsFT_GSqCS_12UsergridAuth_">authForRequests()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines the <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object that will be used for all outgoing requests made.</p>
-
-<p>If there is a valid temporary <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> set by the functions <code>usingAuth</code> or <code>usingToken</code> it will return that.</p>
-
-<p>If there is a <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> logged in and the token of that user is valid then it will return that.</p>
-
-<p>Otherwise, if the <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode">authMode</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</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">authForRequests</span><span class="p">()</span> <span class="o">-></span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> if one is found or nil if not.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient9usingAuthFCS_12UsergridAuthDS0_"></a>
- <a name="//apple_ref/swift/Method/usingAuth(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient9usingAuthFCS_12UsergridAuthDS0_">usingAuth(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the client’s <code>tempAuth</code> property using the passed in <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code>.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">usingAuth</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="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAuth</code> object to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient10usingTokenFSSDS0_"></a>
- <a name="//apple_ref/swift/Method/usingToken(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10usingTokenFSSDS0_">usingToken(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the client’s <code>tempAuth</code> property using the passed in token.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">usingToken</span><span class="p">(</span><span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The access token to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p><code>Self</code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is contained this instance of <code>UsergridCient</code>.</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">authenticateApp</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is passed in.</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">authenticateApp</span><span class="p">(</span><span class="nv">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAppAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in.</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">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:setAsCurrentUser:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:setAsCurrentUser:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in.</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">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">setAsCurrentUser</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>setAsCurrentUser</em>
- </code>
- </td>
- <td>
- <div>
- <p>If the authenticated user should be set as the <code>UsergridClient.currentUser</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a>
- <a name="//apple_ref/swift/Method/resetPassword(_:old:new:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:old:new:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Changes the given <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password.</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">resetPassword</span><span class="p">(</span><span class="nv">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">,</span> <span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserResetPasswordCompletion</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>user</em>
- </code>
- </td>
- <td>
- <div>
- <p>The user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>old</em>
- </code>
- </td>
- <td>
- <div>
- <p>The old password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>new</em>
- </code>
- </td>
- <td>
- <div>
- <p>The new password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_">logoutCurrentUser(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the current user locally and remotely.</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">logoutCurrentUser</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUserAllTokens(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUserAllTokens(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the user remotely with the given tokens.</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">logoutUserAllTokens</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUser(_:token:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUser(_:token:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out a user with the give UUID or username using the shared instance of <code>UsergridCient</code>.</p>
-
-<p>Passing in a token will log out the user for just that token. Passing in nil for the token will logout the user for all tokens.</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">logoutUser</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Generic%20Request%20Methods"></a>
- <a name="//apple_ref/swift/Section/Generic Request Methods" class="dashAnchor"></a>
- <a href="#/Generic%20Request%20Methods">
- <h3 class="section-name">Generic Request Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/sendRequest(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_">sendRequest(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Starts the <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> sending process.</p>
-
-<div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>This method should only be used when you construct your own <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> objects.</p>
-
-</div>
-
- </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">sendRequest</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span><span class="kt">UsergridRequest</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>request</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridRequest</code> object to send.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/GET"></a>
- <a name="//apple_ref/swift/Section/GET" class="dashAnchor"></a>
- <a href="#/GET">
- <h3 class="section-name">GET</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:uuidOrName:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:uuidOrName:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a single <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> of a given type with a specific UUID/name.</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="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</s
<TRUNCATED>
[10/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/NSDate.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/NSDate.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/NSDate.html
deleted file mode 100644
index e69c6e3..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/NSDate.html
+++ /dev/null
@@ -1,448 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>NSDate Extension 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/Extension/NSDate" class="dashAnchor"></a>
- <a title="NSDate Extension 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" />
- NSDate Extension 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>NSDate</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FE11UsergridSDKCSo6NSDatecFT12millisecondsSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(milliseconds:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FE11UsergridSDKCSo6NSDatecFT12millisecondsSS_S0_">init(milliseconds:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a new <code><a href="../Extensions/NSDate.html">NSDate</a></code> object with the given milliseconds.</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">milliseconds</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>milliseconds</em>
- </code>
- </td>
- <td>
- <div>
- <p>the milliseconds</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new <code><a href="../Extensions/NSDate.html">NSDate</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FE11UsergridSDKCSo6NSDate18dateAsMillisecondsFT_Si"></a>
- <a name="//apple_ref/swift/Method/dateAsMilliseconds()" class="dashAnchor"></a>
- <a class="token" href="#/s:FE11UsergridSDKCSo6NSDate18dateAsMillisecondsFT_Si">dateAsMilliseconds()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to milliseconds.</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">dateAsMilliseconds</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The number of milliseconds corresponding to the date.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FE11UsergridSDKCSo6NSDate24dateAsMillisecondsStringFT_SS"></a>
- <a name="//apple_ref/swift/Method/dateAsMillisecondsString()" class="dashAnchor"></a>
- <a class="token" href="#/s:FE11UsergridSDKCSo6NSDate24dateAsMillisecondsStringFT_SS">dateAsMillisecondsString()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to milliseconds and returns the value as a string.</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">dateAsMillisecondsString</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The number of milliseconds corresponding to the date as a string.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFE11UsergridSDKCSo6NSDate22stringFromMillesecondsFSiSS"></a>
- <a name="//apple_ref/swift/Method/stringFromMilleseconds(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate22stringFromMillesecondsFSiSS">stringFromMilleseconds(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the number of milliseconds to a string.</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">static</span> <span class="kd">func</span> <span class="nf">stringFromMilleseconds</span><span class="p">(</span><span class="nv">milliseconds</span><span class="p">:</span><span class="kt">Int</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>milliseconds</em>
- </code>
- </td>
- <td>
- <div>
- <p>the milliseconds to convert</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The milliseconds as a string.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFE11UsergridSDKCSo6NSDate19unixTimeStampStringFT_SS"></a>
- <a name="//apple_ref/swift/Method/unixTimeStampString()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate19unixTimeStampStringFT_SS">unixTimeStampString()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to the corresponding UNIX time stamp as a string.</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">static</span> <span class="kd">func</span> <span class="nf">unixTimeStampString</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The UNIX time stamp as a string.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFE11UsergridSDKCSo6NSDate13unixTimeStampFT_Si"></a>
- <a name="//apple_ref/swift/Method/unixTimeStamp()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate13unixTimeStampFT_Si">unixTimeStamp()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to the corresponding UNIX time stamp.</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">static</span> <span class="kd">func</span> <span class="nf">unixTimeStamp</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The UNIX time stamp.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFE11UsergridSDKCSo6NSDate17nowAsMillisecondsFT_Si"></a>
- <a name="//apple_ref/swift/Method/nowAsMilliseconds()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate17nowAsMillisecondsFT_Si">nowAsMilliseconds()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Converts the current date to milliseconds.</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">static</span> <span class="kd">func</span> <span class="nf">nowAsMilliseconds</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The milliseconds of the current date.</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>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAsset.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAsset.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAsset.html
deleted file mode 100644
index e570062..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAsset.html
+++ /dev/null
@@ -1,184 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAsset Extension 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/Extension/UsergridAsset" class="dashAnchor"></a>
- <a title="UsergridAsset Extension Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html"> Docs</a></p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> Reference</a>
- <img id="carat" src="../img/carat.png" />
- UsergridAsset Extension 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/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/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/UsergridResponse.html">UsergridResponse</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="../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridAsset.html">UsergridAsset</a>
- </li>
- <li class="nav-group-task">
- <a href="../Extensions/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="../Extensions/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Protocols/UsergridAuth.html">UsergridAuth</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridAsset</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK13UsergridAsset17multiPartHTTPBodyCSo6NSData"></a>
- <a name="//apple_ref/swift/Property/multiPartHTTPBody" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset17multiPartHTTPBodyCSo6NSData">multiPartHTTPBody</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridAsset16multipartRequestFS0_FCSo5NSURLCSo19NSMutableURLRequest"></a>
- <a name="//apple_ref/swift/Method/multipartRequest(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAsset16multipartRequestFS0_FCSo5NSURLCSo19NSMutableURLRequest">multipartRequest(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridAsset23multipartRequestAndBodyFS0_FCSo5NSURLT7requestCSo19NSMutableURLRequest13multipartDataCSo6NSData_"></a>
- <a name="//apple_ref/swift/Method/multipartRequestAndBody(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAsset23multipartRequestAndBodyFS0_FCSo5NSURLT7requestCSo19NSMutableURLRequest13multipartDataCSo6NSData_">multipartRequestAndBody(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-20)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/Extensions/UsergridAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAuth.html
deleted file mode 100644
index ff7b963..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAuth.html
+++ /dev/null
@@ -1,260 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuth Extension 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/Extension/UsergridAuth" class="dashAnchor"></a>
- <a title="UsergridAuth Extension Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html"> Docs</a> (46% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> Reference</a>
- <img id="carat" src="../img/carat.png" />
- UsergridAuth Extension 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/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/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/UsergridResponse.html">UsergridResponse</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="../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="../Extensions/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Protocols/UsergridAuth.html">UsergridAuth</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridAuth</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:veRq_11UsergridSDK12UsergridAuth_S_S0_8hasTokenSb"></a>
- <a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a>
- <a class="token" href="#/s:veRq_11UsergridSDK12UsergridAuth_S_S0_8hasTokenSb">hasToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if an access token exists.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">hasToken</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">accessToken</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:veRq_11UsergridSDK12UsergridAuth_S_S0_12tokenIsValidSb"></a>
- <a name="//apple_ref/swift/Property/tokenIsValid" class="dashAnchor"></a>
- <a class="token" href="#/s:veRq_11UsergridSDK12UsergridAuth_S_S0_12tokenIsValidSb">tokenIsValid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if an access token exists and if the token is not expired.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">tokenIsValid</span> <span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">hasToken</span> <span class="o">&&</span> <span class="o">!</span><span class="k">self</span><span class="o">.</span><span class="n">isExpired</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:veRq_11UsergridSDK12UsergridAuth_S_S0_9isExpiredSb"></a>
- <a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a>
- <a class="token" href="#/s:veRq_11UsergridSDK12UsergridAuth_S_S0_9isExpiredSb">isExpired</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if the access token, if one exists, is expired.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isExpired</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FeRq_11UsergridSDK12UsergridAuth_S_S0_16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest"></a>
- <a name="//apple_ref/swift/Method/buildAuthRequest(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FeRq_11UsergridSDK12UsergridAuth_S_S0_16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest">buildAuthRequest(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Builds an authorization request which is can be used to retrieve the access token.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">buildAuthRequest</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="o">-></span> <span class="kt">NSURLRequest</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 of the access token request.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A <code>NSURLRequest</code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-21)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
- </section>
- </article>
- </div>
- </body>
-</div>
-</html>
[27/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Extensions/UsergridClient.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Extensions/UsergridClient.html b/sdks/swift/docs/Extensions/UsergridClient.html
deleted file mode 100644
index d87e6fb..0000000
--- a/sdks/swift/docs/Extensions/UsergridClient.html
+++ /dev/null
@@ -1,1962 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridClient Extension 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/Extension/UsergridClient" class="dashAnchor"></a>
- <a title="UsergridClient Extension Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html"> Docs</a> (88% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> Reference</a>
- <img id="carat" src="../img/carat.png" />
- UsergridClient Extension 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/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/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/UsergridResponse.html">UsergridResponse</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="../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/UsergridEntityProperties.html">UsergridEntityProperties</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/UsergridClient.html">UsergridClient</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>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridClient</h1>
- <div class="declaration">
- <div class="Swift">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p>The <code>UsergridClient</code> class is the base handler for making client connections to and managing relationships with Usergrid’s API.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Authorization"></a>
- <a name="//apple_ref/swift/Section/Authorization" class="dashAnchor"></a>
- <a href="#/Authorization">
- <h3 class="section-name">Authorization</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authForRequestsFS0_FT_GSqCS_12UsergridAuth_"></a>
- <a name="//apple_ref/swift/Method/authForRequests()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authForRequestsFS0_FT_GSqCS_12UsergridAuth_">authForRequests()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines the <code>UsergridAuth</code> object that will be used for all outgoing requests made.</p>
-
-<p>If there is a <code>UsergridUser</code> logged in and the token of that user is valid then it will return that.</p>
-
-<p>Otherwise, if the <code>authFallback</code> is <code>.App</code>, and the <code>UsergridAppAuth</code> of the client is set and the token is valid it will return that.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authForRequests</span><span class="p">()</span> <span class="o">-></span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code>UsergridAuth</code> if one is found or nil if not.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqSS__T__T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqSS__T__T_">authenticateApp(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code>UsergridAppAuth</code> that is contained this instance of <code>UsergridCient</code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqSS__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFS0_FTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqSS__T___T_">authenticateApp(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code>UsergridAppAuth</code> that is passed in.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAppAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqSS__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqSS__T___T_">authenticateUser(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code>UsergridUserAuth</code> that is passed in.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqSS__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:setAsCurrentUser:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFS0_FTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqSS__T___T_">authenticateUser(_:setAsCurrentUser:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code>UsergridUserAuth</code> that is passed in.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">setAsCurrentUser</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>setAsCurrentUser</em>
- </code>
- </td>
- <td>
- <div>
- <p>If the authenticated user should be set as the <code>UsergridClient.currentUser</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFS0_FGSqFT8responseCS_16UsergridResponse_T__T_"></a>
- <a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFS0_FGSqFT8responseCS_16UsergridResponse_T__T_">logoutCurrentUser(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUserAllTokens(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUserAllTokens(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient10logoutUserFS0_FTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUser(_:token:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10logoutUserFS0_FTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUser(_:token:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/GET"></a>
- <a name="//apple_ref/swift/Section/GET" class="dashAnchor"></a>
- <a href="#/GET">
- <h3 class="section-name">GET</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:uuidOrName:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:uuidOrName:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a single <code>UsergridEntity</code> of a given type with a specific UUID/name.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>uuidOrName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The UUID or name of the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:query:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:query:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a group of <code>UsergridEntity</code> objects of a given type with an optional query.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>query</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional query to use when gathering <code>UsergridEntity</code> objects.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/PUT"></a>
- <a name="//apple_ref/swift/Section/PUT" class="dashAnchor"></a>
- <a href="#/PUT">
- <h3 class="section-name">PUT</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTSS10uuidOrNameSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/PUT(_:uuidOrName:jsonBody:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTSS10uuidOrNameSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_">PUT(_:uuidOrName:jsonBody:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates an <code>UsergridEntity</code> with the given type and UUID/name specified using the passed in jsonBody.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">PUT</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">jsonBody</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="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>uuidOrName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The UUID or name of the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionary to update the <code>UsergridEntity</code> with.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/PUT(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_">PUT(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates the passed in <code>UsergridEntity</code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">PUT</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> to update.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/PUT(_:jsonBody:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_">PUT(_:jsonBody:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates an <code>UsergridEntity</code> with the given type using the jsonBody where the UUID/name is specified inside of the jsonBody.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">PUT</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">jsonBody</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="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionary to update the <code>UsergridEntity</code> with.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTCS_13UsergridQuery8jsonBodyGVSs10DictionarySSPSs9AnyObject__15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/PUT(_:jsonBody:queryCompletion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3PUTFS0_FTCS_13UsergridQuery8jsonBodyGVSs10DictionarySSPSs9AnyObject__15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_">PUT(_:jsonBody:queryCompletion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Updates the entities that fit the given query using the passed in jsonBody.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">PUT</span><span class="p">(</span><span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">,</span> <span class="nv">jsonBody</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="nv">queryCompletion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>query</em>
- </code>
- </td>
- <td>
- <div>
- <p>The query to use when filtering what entities to update.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionary to update with.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>queryCompletion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/POST"></a>
- <a name="//apple_ref/swift/Section/POST" class="dashAnchor"></a>
- <a href="#/POST">
- <h3 class="section-name">POST</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/POST(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_">POST(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates and posts creates an <code>UsergridEntity</code>.
-- parameter entity: The <code>UsergridEntity</code> to create.
-- parameter completion: The completion block that will be called once the request has completed.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">POST</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> to create.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTGSaCS_14UsergridEntity_18entitiesCompletionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/POST(_:entitiesCompletion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTGSaCS_14UsergridEntity_18entitiesCompletionGSqFT8responseCS_16UsergridResponse_T___T_">POST(_:entitiesCompletion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates and posts an array of <code>UsergridEntity</code> objects.</p>
-
-<p>Each <code>UsergridEntity</code> in the array much already have a type assigned and must be the same.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">POST</span><span class="p">(</span><span class="nv">entities</span><span class="p">:[</span><span class="kt">UsergridEntity</span><span class="p">],</span> <span class="nv">entitiesCompletion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entities</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> objects to create.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>entitiesCompletion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/POST(_:jsonBody:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_">POST(_:jsonBody:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates and posts an <code>UsergridEntity</code> of the given type with the given jsonBody.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">POST</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">jsonBody</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="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionary to use when creating the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS10jsonBodiesGSaGVSs10DictionarySSPSs9AnyObject___10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/POST(_:jsonBodies:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS10jsonBodiesGSaGVSs10DictionarySSPSs9AnyObject___10completionGSqFT8responseCS_16UsergridResponse_T___T_">POST(_:jsonBodies:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates and posts an array of <code>Entity</code> objects while assigning the given type to them.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">POST</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">jsonBodies</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="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionaries to use when creating the <code>UsergridEntity</code> objects.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS4nameSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/POST(_:name:jsonBody:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient4POSTFS0_FTSS4nameSS8jsonBodyGVSs10DictionarySSPSs9AnyObject__10completionGSqFT8responseCS_16UsergridResponse_T___T_">POST(_:name:jsonBody:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates and posts an <code>UsergridEntity</code> of the given type with a given name and the given jsonBody.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">POST</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">jsonBody</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="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>name</em>
- </code>
- </td>
- <td>
- <div>
- <p>The name of the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The valid JSON body dictionary to use when creating the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/DELETE"></a>
- <a name="//apple_ref/swift/Section/DELETE" class="dashAnchor"></a>
- <a href="#/DELETE">
- <h3 class="section-name">DELETE</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/DELETE(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTCS_14UsergridEntity10completionGSqFT8responseCS_16UsergridResponse_T___T_">DELETE(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Destroys the passed <code>UsergridEntity</code>.
-- parameter entity: The <code>UsergridEntity</code> to delete.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">DELETE</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> to delete.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTCS_13UsergridQuery15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/DELETE(_:queryCompletion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTCS_13UsergridQuery15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_">DELETE(_:queryCompletion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Destroys the <code>UsergridEntity</code> objects that fit the given <code>UsergridQuery</code>.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">DELETE</span><span class="p">(</span><span class="nv">query</span><span class="p">:</span><span class="kt">UsergridQuery</span><span class="p">,</span> <span class="nv">queryCompletion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>query</em>
- </code>
- </td>
- <td>
- <div>
- <p>The query to use when filtering what entities to delete.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>queryCompletion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/DELETE(_:uuidOrName:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient6DELETEFS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">DELETE(_:uuidOrName:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Destroys the <code>UsergridEntity</code> of a given type with a specific UUID/name.
-- parameter type: The <code>UsergridEntity</code> type.
-- parameter uuidOrName: The UUID or name of the <code>UsergridEntity</code>.
-- parameter completion: The completion block that will be called once the request has completed.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">DELETE</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>uuidOrName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The UUID or name of the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Entity%20Connections"></a>
- <a name="//apple_ref/swift/Section/Entity Connections" class="dashAnchor"></a>
- <a href="#/Entity%20Connections">
- <h3 class="section-name">Entity Connections</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient7CONNECTFS0_FTCS_14UsergridEntity12relationshipSS16connectingEntityS1_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/CONNECT(_:relationship:connectingEntity:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient7CONNECTFS0_FTCS_14UsergridEntity12relationshipSS16connectingEntityS1_10completionGSqFT8responseCS_16UsergridResponse_T___T_">CONNECT(_:relationship:connectingEntity:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Connects the <code>UsergridEntity</code> objects via the relationship.
-- parameter entity: The <code>UsergridEntity</code> that will contain the connection.
-- parameter relationship: The relationship of the two entities.
-- parameter connectingEntity: The <code>UsergridEntity</code> which is connected.
-- parameter completion: The completion block that will be called once the request has completed.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">CONNECT</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">connectingEntity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> that will contain the connection.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>relationship</em>
- </code>
- </td>
- <td>
- <div>
- <p>The relationship of the two entities.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>connectingEntity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> which is connected.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK14UsergridClient10DISCONNECTFS0_FTCS_14UsergridEntity12relationshipSS16connectingEntityS1_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/DISCONNECT(_:relationship:connectingEntity:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10DISCONNECTFS0_FTCS_14UsergridEntity12relationshipSS16connectingEntityS1_10completionGSqFT8responseCS_16UsergridResponse_T___T_">DISCONNECT(_:relationship:connectingEntity:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Disconnects the <code>UsergridEntity</code> objects via the relationship.
-- parameter entity: The <code>UsergridEntity</code> that contains the connection.
-- parameter relationship: The relationship of the two entities.
-- parameter connectingEntity: The <code>UsergridEntity</code> which is connected.
-- parameter completion: The completion block that will be called once the request has completed.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="Swift">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">DISCONNECT</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">relationship</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">connectingEntity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> that contains the connection.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>relationship</em>
- </code>
- </td>
- <td>
- <div>
- <p>The relationship of the two entities.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>connectingEntity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> which is connected
<TRUNCATED>
[12/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html
deleted file mode 100644
index a4736a3..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html
+++ /dev/null
@@ -1,369 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridDeviceProperties Enum 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/Enum/UsergridDeviceProperties" class="dashAnchor"></a>
- <a title="UsergridDeviceProperties Enum 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" />
- UsergridDeviceProperties Enum 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>UsergridDeviceProperties</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridDeviceProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridDeviceProperties</code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridDeviceProperties5ModelFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Model" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridDeviceProperties5ModelFMS0_S0_">Model</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘deviceModel’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Model</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridDeviceProperties8PlatformFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Platform" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridDeviceProperties8PlatformFMS0_S0_">Platform</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘devicePlatform’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Platform</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridDeviceProperties9OSVersionFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/OSVersion" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridDeviceProperties9OSVersionFMS0_S0_">OSVersion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘deviceOSVersion’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">OSVersion</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFO11UsergridSDK24UsergridDeviceProperties10fromStringFSSGSqS0__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFO11UsergridSDK24UsergridDeviceProperties10fromStringFSSGSqS0__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets the corresponding <code><a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a></code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridDeviceProperties</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stringValue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The string value to convert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The corresponding <code><a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a></code> or nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK24UsergridDeviceProperties11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK24UsergridDeviceProperties11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Enums/UsergridDirection.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html
deleted file mode 100644
index d11978c..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html
+++ /dev/null
@@ -1,286 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridDirection Enum 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/Enum/UsergridDirection" class="dashAnchor"></a>
- <a title="UsergridDirection Enum 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" />
- UsergridDirection Enum 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>UsergridDirection</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridDirection</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p>An enumeration that is used when getting connections to entity objects. Used to determine which the direction of the connection is wanted.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK17UsergridDirection2InFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/In" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK17UsergridDirection2InFMS0_S0_">In</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>To get the entities that have created a connection to an entity. aka <code>connecting</code></p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">In</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK17UsergridDirection3OutFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Out" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK17UsergridDirection3OutFMS0_S0_">Out</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>To get the entities an entity has connected to. aka <code>connections</code></p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Out</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK17UsergridDirection15connectionValueSS"></a>
- <a name="//apple_ref/swift/Property/connectionValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK17UsergridDirection15connectionValueSS">connectionValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the connection value.</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">connectionValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Enums/UsergridEntityProperties.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html
deleted file mode 100644
index b9b3278..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html
+++ /dev/null
@@ -1,514 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridEntityProperties Enum 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/Enum/UsergridEntityProperties" class="dashAnchor"></a>
- <a title="UsergridEntityProperties Enum 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" />
- UsergridEntityProperties Enum 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>UsergridEntityProperties</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridEntityProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties10EntityTypeFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/EntityType" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties10EntityTypeFMS0_S0_">EntityType</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘type’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">EntityType</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties4UUIDFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/UUID" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties4UUIDFMS0_S0_">UUID</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘uuid’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">UUID</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties4NameFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Name" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties4NameFMS0_S0_">Name</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘name’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Name</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties7CreatedFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Created" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties7CreatedFMS0_S0_">Created</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘created’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Created</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties8ModifiedFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Modified" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties8ModifiedFMS0_S0_">Modified</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘modified’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Modified</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties8LocationFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Location" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties8LocationFMS0_S0_">Location</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘location’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Location</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFO11UsergridSDK24UsergridEntityProperties10fromStringFSSGSqS0__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFO11UsergridSDK24UsergridEntityProperties10fromStringFSSGSqS0__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets the corresponding <code><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridEntityProperties</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stringValue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The string value to convert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The corresponding <code><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> or nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK24UsergridEntityProperties11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK24UsergridEntityProperties11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</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:FO11UsergridSDK24UsergridEntityProperties18isMutableForEntityFCS_14UsergridEntitySb"></a>
- <a name="//apple_ref/swift/Method/isMutableForEntity(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties18isMutableForEntityFCS_14UsergridEntitySb">isMutableForEntity(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if the <code><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> is mutable for the given entity.</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">isMutableForEntity</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The entity to check.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>If the <code><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> is mutable for the given entity</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>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridHttpMethod.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridHttpMethod.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridHttpMethod.html
deleted file mode 100644
index 1ad6cbb..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridHttpMethod.html
+++ /dev/null
@@ -1,341 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridHttpMethod Enum 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/Enum/UsergridHttpMethod" class="dashAnchor"></a>
- <a title="UsergridHttpMethod Enum 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" />
- UsergridHttpMethod Enum 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>UsergridHttpMethod</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridHttpMethod</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p>An enumeration for defining the HTTP methods used by Usergrid.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK18UsergridHttpMethod3GetFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Get" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod3GetFMS0_S0_">Get</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>GET</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Get</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK18UsergridHttpMethod3PutFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Put" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod3PutFMS0_S0_">Put</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>PUT</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Put</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK18UsergridHttpMethod4PostFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Post" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod4PostFMS0_S0_">Post</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>POST</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Post</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK18UsergridHttpMethod6DeleteFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Delete" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod6DeleteFMS0_S0_">Delete</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>DELETE</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Delete</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK18UsergridHttpMethod11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK18UsergridHttpMethod11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Enums/UsergridImageContentType.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridImageContentType.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridImageContentType.html
deleted file mode 100644
index 224450b..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridImageContentType.html
+++ /dev/null
@@ -1,286 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridImageContentType Enum 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/Enum/UsergridImageContentType" class="dashAnchor"></a>
- <a title="UsergridImageContentType Enum 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" />
- UsergridImageContentType Enum 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>UsergridImageContentType</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridImageContentType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> image specific content types.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridImageContentType3PngFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Png" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridImageContentType3PngFMS0_S0_">Png</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Content type: ‘image/png’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Png</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridImageContentType4JpegFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Jpeg" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridImageContentType4JpegFMS0_S0_">Jpeg</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Content type: ‘image/jpeg’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Jpeg</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK24UsergridImageContentType11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK24UsergridImageContentType11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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>
[30/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Enums/UsergridDeviceProperties.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridDeviceProperties.html b/sdks/swift/docs/Enums/UsergridDeviceProperties.html
deleted file mode 100644
index a4736a3..0000000
--- a/sdks/swift/docs/Enums/UsergridDeviceProperties.html
+++ /dev/null
@@ -1,369 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridDeviceProperties Enum 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/Enum/UsergridDeviceProperties" class="dashAnchor"></a>
- <a title="UsergridDeviceProperties Enum 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" />
- UsergridDeviceProperties Enum 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>UsergridDeviceProperties</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridDeviceProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridDeviceProperties</code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridDeviceProperties5ModelFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Model" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridDeviceProperties5ModelFMS0_S0_">Model</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘deviceModel’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Model</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridDeviceProperties8PlatformFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Platform" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridDeviceProperties8PlatformFMS0_S0_">Platform</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘devicePlatform’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Platform</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridDeviceProperties9OSVersionFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/OSVersion" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridDeviceProperties9OSVersionFMS0_S0_">OSVersion</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘deviceOSVersion’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">OSVersion</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFO11UsergridSDK24UsergridDeviceProperties10fromStringFSSGSqS0__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFO11UsergridSDK24UsergridDeviceProperties10fromStringFSSGSqS0__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets the corresponding <code><a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a></code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridDeviceProperties</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stringValue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The string value to convert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The corresponding <code><a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a></code> or nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK24UsergridDeviceProperties11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK24UsergridDeviceProperties11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Enums/UsergridDirection.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridDirection.html b/sdks/swift/docs/Enums/UsergridDirection.html
deleted file mode 100644
index d11978c..0000000
--- a/sdks/swift/docs/Enums/UsergridDirection.html
+++ /dev/null
@@ -1,286 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridDirection Enum 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/Enum/UsergridDirection" class="dashAnchor"></a>
- <a title="UsergridDirection Enum 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" />
- UsergridDirection Enum 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>UsergridDirection</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridDirection</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p>An enumeration that is used when getting connections to entity objects. Used to determine which the direction of the connection is wanted.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK17UsergridDirection2InFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/In" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK17UsergridDirection2InFMS0_S0_">In</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>To get the entities that have created a connection to an entity. aka <code>connecting</code></p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">In</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK17UsergridDirection3OutFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Out" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK17UsergridDirection3OutFMS0_S0_">Out</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>To get the entities an entity has connected to. aka <code>connections</code></p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Out</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK17UsergridDirection15connectionValueSS"></a>
- <a name="//apple_ref/swift/Property/connectionValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK17UsergridDirection15connectionValueSS">connectionValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the connection value.</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">connectionValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Enums/UsergridEntityProperties.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridEntityProperties.html b/sdks/swift/docs/Enums/UsergridEntityProperties.html
deleted file mode 100644
index b9b3278..0000000
--- a/sdks/swift/docs/Enums/UsergridEntityProperties.html
+++ /dev/null
@@ -1,514 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridEntityProperties Enum 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/Enum/UsergridEntityProperties" class="dashAnchor"></a>
- <a title="UsergridEntityProperties Enum 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" />
- UsergridEntityProperties Enum 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>UsergridEntityProperties</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridEntityProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties10EntityTypeFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/EntityType" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties10EntityTypeFMS0_S0_">EntityType</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘type’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">EntityType</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties4UUIDFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/UUID" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties4UUIDFMS0_S0_">UUID</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘uuid’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">UUID</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties4NameFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Name" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties4NameFMS0_S0_">Name</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘name’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Name</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties7CreatedFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Created" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties7CreatedFMS0_S0_">Created</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘created’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Created</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties8ModifiedFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Modified" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties8ModifiedFMS0_S0_">Modified</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘modified’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Modified</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridEntityProperties8LocationFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Location" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties8LocationFMS0_S0_">Location</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Corresponds to the property ‘location’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Location</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFO11UsergridSDK24UsergridEntityProperties10fromStringFSSGSqS0__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFO11UsergridSDK24UsergridEntityProperties10fromStringFSSGSqS0__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets the corresponding <code><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridEntityProperties</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stringValue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The string value to convert.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The corresponding <code><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> or nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK24UsergridEntityProperties11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK24UsergridEntityProperties11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</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:FO11UsergridSDK24UsergridEntityProperties18isMutableForEntityFCS_14UsergridEntitySb"></a>
- <a name="//apple_ref/swift/Method/isMutableForEntity(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties18isMutableForEntityFCS_14UsergridEntitySb">isMutableForEntity(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if the <code><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> is mutable for the given entity.</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">isMutableForEntity</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>entity</em>
- </code>
- </td>
- <td>
- <div>
- <p>The entity to check.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>If the <code><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> is mutable for the given entity</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>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Enums/UsergridHttpMethod.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridHttpMethod.html b/sdks/swift/docs/Enums/UsergridHttpMethod.html
deleted file mode 100644
index 1ad6cbb..0000000
--- a/sdks/swift/docs/Enums/UsergridHttpMethod.html
+++ /dev/null
@@ -1,341 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridHttpMethod Enum 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/Enum/UsergridHttpMethod" class="dashAnchor"></a>
- <a title="UsergridHttpMethod Enum 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" />
- UsergridHttpMethod Enum 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>UsergridHttpMethod</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridHttpMethod</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p>An enumeration for defining the HTTP methods used by Usergrid.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK18UsergridHttpMethod3GetFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Get" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod3GetFMS0_S0_">Get</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>GET</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Get</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK18UsergridHttpMethod3PutFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Put" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod3PutFMS0_S0_">Put</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>PUT</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Put</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK18UsergridHttpMethod4PostFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Post" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod4PostFMS0_S0_">Post</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>POST</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Post</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK18UsergridHttpMethod6DeleteFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Delete" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod6DeleteFMS0_S0_">Delete</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>DELETE</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Delete</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK18UsergridHttpMethod11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK18UsergridHttpMethod11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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/Enums/UsergridImageContentType.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridImageContentType.html b/sdks/swift/docs/Enums/UsergridImageContentType.html
deleted file mode 100644
index 224450b..0000000
--- a/sdks/swift/docs/Enums/UsergridImageContentType.html
+++ /dev/null
@@ -1,286 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridImageContentType Enum 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/Enum/UsergridImageContentType" class="dashAnchor"></a>
- <a title="UsergridImageContentType Enum 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" />
- UsergridImageContentType Enum 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>UsergridImageContentType</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridImageContentType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- <p><code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> image specific content types.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridImageContentType3PngFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Png" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridImageContentType3PngFMS0_S0_">Png</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Content type: ‘image/png’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Png</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FO11UsergridSDK24UsergridImageContentType4JpegFMS0_S0_"></a>
- <a name="//apple_ref/swift/Element/Jpeg" class="dashAnchor"></a>
- <a class="token" href="#/s:FO11UsergridSDK24UsergridImageContentType4JpegFMS0_S0_">Jpeg</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Content type: ‘image/jpeg’</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">case</span> <span class="kt">Jpeg</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Methods"></a>
- <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
- <a href="#/Methods">
- <h3 class="section-name">Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:vO11UsergridSDK24UsergridImageContentType11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vO11UsergridSDK24UsergridImageContentType11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </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>
[24/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html
deleted file mode 100644
index 61bf26f..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html
+++ /dev/null
@@ -1,3798 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Usergrid 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/Usergrid" class="dashAnchor"></a>
- <a title="Usergrid 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" />
- Usergrid 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>Usergrid</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Usergrid</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p>The <code>Usergrid</code> class acts as a static shared instance manager for the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> class.</p>
-
-<p>The methods and variables in this class are all static and therefore you will never need or want to initialize an instance of the <code>Usergrid</code> class.</p>
-
-<p>Use of this class depends on initialization of the shared instance of the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> object. Because of this, before using any of the static methods
-provided you will need to call one of the shared instance initialization methods. Failure to do so will result in failure from all methods.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Static%20Variables"></a>
- <a name="//apple_ref/swift/Section/Static Variables" class="dashAnchor"></a>
- <a href="#/Static%20Variables">
- <h3 class="section-name">Static Variables</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid13isInitializedSb"></a>
- <a name="//apple_ref/swift/Variable/isInitialized" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid13isInitializedSb">isInitialized</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Used to determine if the shared instance of the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> has been initialized.</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">static</span> <span class="k">var</span> <span class="nv">isInitialized</span> <span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">_sharedClient</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Variable/sharedInstance" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">sharedInstance</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, used by the <code><a href="../Classes/Usergrid.html">Usergrid</a></code> static methods and acts as the default <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>
-within the UsergridSDK library.</p>
-
-<div class="aside aside-warning">
- <p class="aside-title">Warning</p>
- You must call one of the <code>Usergrid.initSharedInstance</code> methods before this or any other <code><a href="../Classes/Usergrid.html">Usergrid</a></code> static methods are valid.
-
-</div>
-
- </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">static</span> <span class="k">var</span> <span class="nv">sharedInstance</span> <span class="p">:</span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid5appIdSS"></a>
- <a name="//apple_ref/swift/Variable/appId" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid5appIdSS">appId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application identifier the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">appId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">appId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid5orgIdSS"></a>
- <a name="//apple_ref/swift/Variable/orgId" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid5orgIdSS">orgId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The organization identifier of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">orgId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">orgId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid7baseUrlSS"></a>
- <a name="//apple_ref/swift/Variable/baseUrl" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid7baseUrlSS">baseUrl</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The base URL that all calls will be made with of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">baseUrl</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">baseUrl</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid12clientAppURLSS"></a>
- <a name="//apple_ref/swift/Variable/clientAppURL" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid12clientAppURLSS">clientAppURL</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The constructed URL string based on the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s baseUrl, orgId, and appId of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">clientAppURL</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">clientAppURL</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_"></a>
- <a name="//apple_ref/swift/Variable/currentUser" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_">currentUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The currently logged in <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">currentUser</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">currentUser</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid28persistCurrentUserInKeychainSb"></a>
- <a name="//apple_ref/swift/Variable/persistCurrentUserInKeychain" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Whether or not the current user will be saved and restored from the keychain using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid8userAuthGSqCS_16UsergridUserAuth_"></a>
- <a name="//apple_ref/swift/Variable/userAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid8userAuthGSqCS_16UsergridUserAuth_">userAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> which consists of the token information from the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_">currentUser</a></code> property of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">userAuth</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid7appAuthGSqCS_15UsergridAppAuth_"></a>
- <a name="//apple_ref/swift/Variable/appAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid7appAuthGSqCS_15UsergridAppAuth_">appAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application level <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid8authModeOS_16UsergridAuthMode"></a>
- <a name="//apple_ref/swift/Variable/authMode" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid8authModeOS_16UsergridAuthMode">authMode</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, if any.</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">static</span> <span class="k">var</span> <span class="nv">authMode</span><span class="p">:</span> <span class="kt">UsergridAuthMode</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:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS_CS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/initSharedInstance(orgId:appId:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS_CS_14UsergridClient">initSharedInstance(orgId:appId:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">orgId</span> <span class="nv">orgId</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS7baseUrlSS_CS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/initSharedInstance(orgId:appId:baseUrl:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS7baseUrlSS_CS_14UsergridClient">initSharedInstance(orgId:appId:baseUrl:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">orgId</span> <span class="nv">orgId</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</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="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>baseUrl</em>
- </code>
- </td>
- <td>
- <div>
- <p>The base URL that all calls will be made with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT13configurationCS_20UsergridClientConfig_CS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/initSharedInstance(configuration:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT13configurationCS_20UsergridClientConfig_CS_14UsergridClient">initSharedInstance(configuration:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">configuration</span> <span class="nv">configuration</span><span class="p">:</span> <span class="kt">UsergridClientConfig</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>configuration</em>
- </code>
- </td>
- <td>
- <div>
- <p>The configuration for the client to be set up with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Push%20Notifications"></a>
- <a name="//apple_ref/swift/Section/Push Notifications" class="dashAnchor"></a>
- <a href="#/Push%20Notifications">
- <h3 class="section-name">Push Notifications</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the shared <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">applyPushToken</span><span class="p">(</span><span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:pushToken:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:pushToken:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the given <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">applyPushToken</span><span class="p">(</span><span class="nv">device</span><span class="p">:</span> <span class="kt">UsergridDevice</span><span class="p">,</span> <span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>device</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridDevice</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Authorization"></a>
- <a name="//apple_ref/swift/Section/Authorization" class="dashAnchor"></a>
- <a href="#/Authorization">
- <h3 class="section-name">Authorization</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid9usingAuthFCS_12UsergridAuthCS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/usingAuth(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid9usingAuthFCS_12UsergridAuthCS_14UsergridClient">usingAuth(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the shared <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s <code>tempAuth</code> property using the passed in <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code>.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">static</span> <span class="kd">func</span> <span class="nf">usingAuth</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="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAuth</code> object to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid10usingTokenFSSCS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/usingToken(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid10usingTokenFSSCS_14UsergridClient">usingToken(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the shared <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s <code>tempAuth</code> property using the passed in token.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">static</span> <span class="kd">func</span> <span class="nf">usingToken</span><span class="p">(</span><span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The access token to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid15authForRequestsFT_GSqCS_12UsergridAuth_"></a>
- <a name="//apple_ref/swift/Method/authForRequests()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authForRequestsFT_GSqCS_12UsergridAuth_">authForRequests()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines the <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object that will be used for all outgoing requests made by the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
-<p>If there is a <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> logged in and the token of that user is valid then it will return that.</p>
-
-<p>Otherwise, if the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid8authModeOS_16UsergridAuthMode">authMode</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</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">static</span> <span class="kd">func</span> <span class="nf">authForRequests</span><span class="p">()</span> <span class="o">-></span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> if one is found or nil if not.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is contained within the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is passed in using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">auth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAppAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">auth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:setAsCurrentUser:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:setAsCurrentUser:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">setAsCurrentUser</span><span class="p">:</span><span class="kt">Bool</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>setAsCurrentUser</em>
- </code>
- </td>
- <td>
- <div>
- <p>If the authenticated user should be set as the <code>UsergridClient.currentUser</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a>
- <a name="//apple_ref/swift/Method/resetPassword(_:old:new:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:old:new:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Changes the given <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">resetPassword</span><span class="p">(</span><span class="nv">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">,</span> <span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserResetPasswordCompletion</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>user</em>
- </code>
- </td>
- <td>
- <div>
- <p>The user.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>old</em>
- </code>
- </td>
- <td>
- <div>
- <p>The old password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>new</em>
- </code>
- </td>
- <td>
- <div>
- <p>The new password.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_">logoutCurrentUser(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the current user of the shared instance locally and remotely using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">logoutCurrentUser</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUserAllTokens(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUserAllTokens(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the user remotely with the given tokens using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">logoutUserAllTokens</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUser(_:token:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUser(_:token:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out a user with the give UUID or username using the shared instance of <code>UsergridCient</code>.</p>
-
-<p>Passing in a token will log out the user for just that token. Passing in nil for the token will logout the user for all tokens.</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">static</span> <span class="kd">func</span> <span class="nf">logoutUser</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Generic%20Request%20Methods"></a>
- <a name="//apple_ref/swift/Section/Generic Request Methods" class="dashAnchor"></a>
- <a href="#/Generic%20Request%20Methods">
- <h3 class="section-name">Generic Request Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/sendRequest(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_">sendRequest(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Starts the <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> sending process using the shared instance of <code>UsergridCient</code>.</p>
-
-<div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>This method should only be used when you construct your own `UsergridRequest objects.</p>
-
-</div>
-
- </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">static</span> <span class="kd">func</span> <span class="nf">sendRequest</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span><span class="kt">UsergridRequest</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>request</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridRequest</code> object to send.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/GET"></a>
- <a name="//apple_ref/swift/Section/GET" class="dashAnchor"></a>
- <a href="#/GET">
- <h3 class="section-name">GET</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:uuidOrName:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:uuidOrName:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a single <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> of a given type with a specific UUID/name using the shared instance of <code>Use
<TRUNCATED>
[04/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/Usergrid.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/Usergrid.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/Usergrid.html
deleted file mode 100644
index d959029..0000000
--- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/Usergrid.html
+++ /dev/null
@@ -1,3704 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>Usergrid 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/Usergrid" class="dashAnchor"></a>
- <a title="Usergrid 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" />
- Usergrid 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>Usergrid</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Usergrid</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p>The <code>Usergrid</code> class acts as a static shared instance manager for the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> class.</p>
-
-<p>The methods and variables in this class are all static and therefore you will never need or want to initialize an instance of the <code>Usergrid</code> class.</p>
-
-<p>Use of this class depends on initialization of the shared instance of the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> object. Because of this, before using any of the static methods
-provided you will need to call one of the shared instance initialization methods. Failure to do so will result in failure from all methods.</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Static%20Variables"></a>
- <a name="//apple_ref/swift/Section/Static Variables" class="dashAnchor"></a>
- <a href="#/Static%20Variables">
- <h3 class="section-name">Static Variables</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid13isInitializedSb"></a>
- <a name="//apple_ref/swift/Variable/isInitialized" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid13isInitializedSb">isInitialized</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Used to determine if the shared instance of the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> has been initialized.</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">static</span> <span class="k">var</span> <span class="nv">isInitialized</span> <span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">_sharedClient</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Variable/sharedInstance" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">sharedInstance</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, used by the <code><a href="../Classes/Usergrid.html">Usergrid</a></code> static methods and acts as the default <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>
-within the UsergridSDK library.</p>
-
-<div class="aside aside-warning">
- <p class="aside-title">Warning</p>
- You must call one of the <code>Usergrid.initSharedInstance</code> methods before this or any other <code><a href="../Classes/Usergrid.html">Usergrid</a></code> static methods are valid.
-
-</div>
-
- </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">static</span> <span class="k">var</span> <span class="nv">sharedInstance</span> <span class="p">:</span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid5appIdSS"></a>
- <a name="//apple_ref/swift/Variable/appId" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid5appIdSS">appId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application identifier the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">appId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">appId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid5orgIdSS"></a>
- <a name="//apple_ref/swift/Variable/orgId" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid5orgIdSS">orgId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The organization identifier of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">orgId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">orgId</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid7baseUrlSS"></a>
- <a name="//apple_ref/swift/Variable/baseUrl" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid7baseUrlSS">baseUrl</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The base URL that all calls will be made with of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">baseUrl</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">baseUrl</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid12clientAppURLSS"></a>
- <a name="//apple_ref/swift/Variable/clientAppURL" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid12clientAppURLSS">clientAppURL</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The constructed URL string based on the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s baseUrl, orgId, and appId of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">clientAppURL</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">clientAppURL</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_"></a>
- <a name="//apple_ref/swift/Variable/currentUser" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_">currentUser</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The currently logged in <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">currentUser</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">currentUser</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid28persistCurrentUserInKeychainSb"></a>
- <a name="//apple_ref/swift/Variable/persistCurrentUserInKeychain" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Whether or not the current user will be saved and restored from the keychain using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid8userAuthGSqCS_16UsergridUserAuth_"></a>
- <a name="//apple_ref/swift/Variable/userAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid8userAuthGSqCS_16UsergridUserAuth_">userAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> which consists of the token information from the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_">currentUser</a></code> property of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">userAuth</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid7appAuthGSqCS_15UsergridAppAuth_"></a>
- <a name="//apple_ref/swift/Variable/appAuth" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid7appAuthGSqCS_15UsergridAppAuth_">appAuth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The application level <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="k">var</span> <span class="nv">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZvC11UsergridSDK8Usergrid12authFallbackOS_20UsergridAuthFallback"></a>
- <a name="//apple_ref/swift/Variable/authFallback" class="dashAnchor"></a>
- <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid12authFallbackOS_20UsergridAuthFallback">authFallback</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Enums/UsergridAuthFallback.html">UsergridAuthFallback</a></code> value used to determine what type of token will be sent of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, if any.</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">static</span> <span class="k">var</span> <span class="nv">authFallback</span><span class="p">:</span> <span class="kt">UsergridAuthFallback</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:ZFC11UsergridSDK8Usergrid18initSharedInstanceFMS0_FT5orgIdSS5appIdSS_CS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/initSharedInstance(orgId:appId:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFMS0_FT5orgIdSS5appIdSS_CS_14UsergridClient">initSharedInstance(orgId:appId:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">orgId</span> <span class="nv">orgId</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFMS0_FT5orgIdSS5appIdSS7baseUrlSS_CS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/initSharedInstance(orgId:appId:baseUrl:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFMS0_FT5orgIdSS5appIdSS7baseUrlSS_CS_14UsergridClient">initSharedInstance(orgId:appId:baseUrl:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">orgId</span> <span class="nv">orgId</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</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="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>orgId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The organization identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>appId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The application identifier.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>baseUrl</em>
- </code>
- </td>
- <td>
- <div>
- <p>The base URL that all calls will be made with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFMS0_FT13configurationCS_20UsergridClientConfig_CS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/initSharedInstance(configuration:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFMS0_FT13configurationCS_20UsergridClientConfig_CS_14UsergridClient">initSharedInstance(configuration:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializes the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">configuration</span> <span class="nv">configuration</span><span class="p">:</span> <span class="kt">UsergridClientConfig</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>configuration</em>
- </code>
- </td>
- <td>
- <div>
- <p>The configuration for the client to be set up with.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Push%20Notifications"></a>
- <a name="//apple_ref/swift/Section/Push Notifications" class="dashAnchor"></a>
- <a href="#/Push%20Notifications">
- <h3 class="section-name">Push Notifications</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFMS0_FTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFMS0_FTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the shared <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">applyPushToken</span><span class="p">(</span><span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFMS0_FTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/applyPushToken(_:pushToken:notifierID:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFMS0_FTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:pushToken:notifierID:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the push token for the given notifier ID and performs a PUT request to update the given <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">applyPushToken</span><span class="p">(</span><span class="nv">device</span><span class="p">:</span> <span class="kt">UsergridDevice</span><span class="p">,</span> <span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>device</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridDevice</code> object.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>pushToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The push token from Apple.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>notifierID</em>
- </code>
- </td>
- <td>
- <div>
- <p>The Usergrid notifier ID.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Authorization"></a>
- <a name="//apple_ref/swift/Section/Authorization" class="dashAnchor"></a>
- <a href="#/Authorization">
- <h3 class="section-name">Authorization</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid9usingAuthFMS0_FCS_12UsergridAuthCS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/usingAuth(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid9usingAuthFMS0_FCS_12UsergridAuthCS_14UsergridClient">usingAuth(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the shared <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s <code>tempAuth</code> property using the passed in <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code>.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">static</span> <span class="kd">func</span> <span class="nf">usingAuth</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="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAuth</code> object to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid10usingTokenFMS0_FSSCS_14UsergridClient"></a>
- <a name="//apple_ref/swift/Method/usingToken(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid10usingTokenFMS0_FSSCS_14UsergridClient">usingToken(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the shared <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s <code>tempAuth</code> property using the passed in token.</p>
-
-<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">static</span> <span class="kd">func</span> <span class="nf">usingToken</span><span class="p">(</span><span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridClient</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The access token to temporarily use for authentication.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code></p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid15authForRequestsFMS0_FT_GSqCS_12UsergridAuth_"></a>
- <a name="//apple_ref/swift/Method/authForRequests()" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authForRequestsFMS0_FT_GSqCS_12UsergridAuth_">authForRequests()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines the <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object that will be used for all outgoing requests made by the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
-
-<p>If there is a <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> logged in and the token of that user is valid then it will return that.</p>
-
-<p>Otherwise, if the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid12authFallbackOS_20UsergridAuthFallback">authFallback</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</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">static</span> <span class="kd">func</span> <span class="nf">authForRequests</span><span class="p">()</span> <span class="o">-></span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> if one is found or nil if not.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid15authenticateAppFMS0_FTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authenticateAppFMS0_FTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is contained within the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid15authenticateAppFMS0_FTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateApp(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authenticateAppFMS0_FTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is passed in using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">auth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridAppAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid16authenticateUserFMS0_FTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid16authenticateUserFMS0_FTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">auth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid16authenticateUserFMS0_FTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a>
- <a name="//apple_ref/swift/Method/authenticateUser(_:setAsCurrentUser:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid16authenticateUserFMS0_FTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:setAsCurrentUser:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">setAsCurrentUser</span><span class="p">:</span><span class="kt">Bool</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridUserAuth</code> that will be authenticated.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>setAsCurrentUser</em>
- </code>
- </td>
- <td>
- <div>
- <p>If the authenticated user should be set as the <code>UsergridClient.currentUser</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after authentication has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFMS0_FTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFMS0_FTGSqFT8responseCS_16UsergridResponse_T___T_">logoutCurrentUser(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the current user of the shared instance locally and remotely.</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">static</span> <span class="kd">func</span> <span class="nf">logoutCurrentUser</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid19logoutUserAllTokensFMS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUserAllTokens(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid19logoutUserAllTokensFMS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUserAllTokens(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out the user remotely with the given tokens using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="nf">logoutUserAllTokens</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid10logoutUserFMS0_FTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/logoutUser(_:token:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid10logoutUserFMS0_FTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUser(_:token:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Logs out a user with the give UUID or username using the shared instance of <code>UsergridCient</code>.</p>
-
-<p>Passing in a token will log out the user for just that token. Passing in nil for the token will logout the user for all tokens.</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">static</span> <span class="kd">func</span> <span class="nf">logoutUser</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">token</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called after logout has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Generic%20Request%20Methods"></a>
- <a name="//apple_ref/swift/Section/Generic Request Methods" class="dashAnchor"></a>
- <a href="#/Generic%20Request%20Methods">
- <h3 class="section-name">Generic Request Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid11sendRequestFMS0_FTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/sendRequest(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid11sendRequestFMS0_FTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_">sendRequest(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Starts the <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> sending process using the shared instance of <code>UsergridCient</code>.</p>
-
-<div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>This method should only be used when you construct your own `UsergridRequest objects.</p>
-
-</div>
-
- </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">static</span> <span class="kd">func</span> <span class="nf">sendRequest</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span><span class="kt">UsergridRequest</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</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>request</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridRequest</code> object to send.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/GET"></a>
- <a name="//apple_ref/swift/Section/GET" class="dashAnchor"></a>
- <a href="#/GET">
- <h3 class="section-name">GET</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid3GETFMS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:uuidOrName:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid3GETFMS0_FTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:uuidOrName:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a single <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> of a given type with a specific UUID/name using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">uuidOrName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</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>type</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UsergridEntity</code> type.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>uuidOrName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The UUID or name of the <code>UsergridEntity</code>.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The completion block that will be called once the request has completed.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFC11UsergridSDK8Usergrid3GETFMS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
- <a name="//apple_ref/swift/Method/GET(_:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid3GETFMS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Gets a group of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects of a given type using the shared instance of <code>UsergridCient</code>.</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">static</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></
<TRUNCATED>
[34/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridQuery/UsergridQueryOperator.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridQuery/UsergridQueryOperator.html b/sdks/swift/docs/Classes/UsergridQuery/UsergridQueryOperator.html
deleted file mode 100644
index 0b518b1..0000000
--- a/sdks/swift/docs/Classes/UsergridQuery/UsergridQueryOperator.html
+++ /dev/null
@@ -1,272 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridQueryOperator Enum 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/Enum/UsergridQueryOperator" class="dashAnchor"></a>
- <a title="UsergridQueryOperator Enum Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../../index.html"> Docs</a> (51% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../../index.html"> Reference</a>
- <img id="carat" src="../../img/carat.png" />
- UsergridQueryOperator Enum 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/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/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/UsergridResponse.html">UsergridResponse</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="../../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridQueryOperator</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator5EqualFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Equal" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator5EqualFMS1_S1_">Equal</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator11GreaterThanFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/GreaterThan" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator11GreaterThanFMS1_S1_">GreaterThan</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator18GreaterThanEqualToFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/GreaterThanEqualTo" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator18GreaterThanEqualToFMS1_S1_">GreaterThanEqualTo</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator8LessThanFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/LessThan" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator8LessThanFMS1_S1_">LessThan</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator15LessThanEqualToFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/LessThanEqualTo" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery21UsergridQueryOperator15LessThanEqualToFMS1_S1_">LessThanEqualTo</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFOC11UsergridSDK13UsergridQuery21UsergridQueryOperator10fromStringFMS1_FSSGSqS1__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFOC11UsergridSDK13UsergridQuery21UsergridQueryOperator10fromStringFMS1_FSSGSqS1__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vOC11UsergridSDK13UsergridQuery21UsergridQueryOperator11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vOC11UsergridSDK13UsergridQuery21UsergridQueryOperator11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-21)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/Classes/UsergridQuery/UsergridQuerySortOrder.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridQuery/UsergridQuerySortOrder.html b/sdks/swift/docs/Classes/UsergridQuery/UsergridQuerySortOrder.html
deleted file mode 100644
index afe97c4..0000000
--- a/sdks/swift/docs/Classes/UsergridQuery/UsergridQuerySortOrder.html
+++ /dev/null
@@ -1,203 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridQuerySortOrder Enum 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/Enum/UsergridQuerySortOrder" class="dashAnchor"></a>
- <a title="UsergridQuerySortOrder Enum Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../../index.html"> Docs</a> (51% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../../index.html"> Reference</a>
- <img id="carat" src="../../img/carat.png" />
- UsergridQuerySortOrder Enum 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/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/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/UsergridResponse.html">UsergridResponse</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="../../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/UsergridEntityProperties.html">UsergridEntityProperties</a>
- </li>
- <li class="nav-group-task">
- <a href="../../Enums/UsergridImageContentType.html">UsergridImageContentType</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/UsergridClient.html">UsergridClient</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridQuerySortOrder</h1>
- <p>Undocumented</p>
-
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder3AscFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Asc" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder3AscFMS1_S1_">Asc</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder4DescFMS1_S1_"></a>
- <a name="//apple_ref/swift/Element/Desc" class="dashAnchor"></a>
- <a class="token" href="#/s:FOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder4DescFMS1_S1_">Desc</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:ZFOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder10fromStringFMS1_FSSGSqS1__"></a>
- <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:ZFOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder10fromStringFMS1_FSSGSqS1__">fromString(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder11stringValueSS"></a>
- <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
- <a class="token" href="#/s:vOC11UsergridSDK13UsergridQuery22UsergridQuerySortOrder11stringValueSS">stringValue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-21)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.3.2</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/Classes/UsergridRequest.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridRequest.html b/sdks/swift/docs/Classes/UsergridRequest.html
deleted file mode 100644
index 0405ff5..0000000
--- a/sdks/swift/docs/Classes/UsergridRequest.html
+++ /dev/null
@@ -1,619 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridRequest 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/UsergridRequest" class="dashAnchor"></a>
- <a title="UsergridRequest 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" />
- UsergridRequest 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>UsergridRequest</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridRequest</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
-
- </div>
- </div>
- <p>The UsergridRequest class incapsulates the properties that all requests made by the SDK have in common. </p>
-
-<p>This class is also functions to create <code>NSURLRequest</code> objects based on the properties of the class.</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:vC11UsergridSDK15UsergridRequest6methodOS_18UsergridHttpMethod"></a>
- <a name="//apple_ref/swift/Property/method" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest6methodOS_18UsergridHttpMethod">method</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The HTTP method.</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">method</span><span class="p">:</span> <span class="kt">UsergridHttpMethod</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK15UsergridRequest7baseUrlSS"></a>
- <a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest7baseUrlSS">baseUrl</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The base URL.</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">baseUrl</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:vC11UsergridSDK15UsergridRequest5pathsGSqGSaSS__"></a>
- <a name="//apple_ref/swift/Property/paths" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest5pathsGSqGSaSS__">paths</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The paths to append to the base URL.</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">paths</span><span class="p">:</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:vC11UsergridSDK15UsergridRequest5queryGSqCS_13UsergridQuery_"></a>
- <a name="//apple_ref/swift/Property/query" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest5queryGSqCS_13UsergridQuery_">query</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The query to append to the URL.</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">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK15UsergridRequest4authGSqCS_12UsergridAuth_"></a>
- <a name="//apple_ref/swift/Property/auth" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest4authGSqCS_12UsergridAuth_">auth</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The auth that will be used.</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">auth</span><span class="p">:</span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK15UsergridRequest7headersGSqGVs10DictionarySSSS__"></a>
- <a name="//apple_ref/swift/Property/headers" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest7headersGSqGVs10DictionarySSSS__">headers</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The headers to add to the 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">headers</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</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:vC11UsergridSDK15UsergridRequest8jsonBodyGSqPs9AnyObject__"></a>
- <a name="//apple_ref/swift/Property/jsonBody" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest8jsonBodyGSqPs9AnyObject__">jsonBody</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The JSON body that will be set on the request. Can be either a valid JSON object or NSData.</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">jsonBody</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK15UsergridRequest11queryParamsGSqGVs10DictionarySSSS__"></a>
- <a name="//apple_ref/swift/Property/queryParams" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest11queryParamsGSqGVs10DictionarySSSS__">queryParams</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The query params that will be set on the 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">queryParams</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</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:FC11UsergridSDK15UsergridRequestcFT6methodOS_18UsergridHttpMethod7baseUrlSS5pathsGSqGSaSS__5queryGSqCS_13UsergridQuery_4authGSqCS_12UsergridAuth_7headersGSqGVs10DictionarySSSS__8jsonBodyGSqPs9AnyObject__11queryParamsGSqGS4_SSSS___S0_"></a>
- <a name="//apple_ref/swift/Method/init(method:baseUrl:paths:query:auth:headers:jsonBody:queryParams:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK15UsergridRequestcFT6methodOS_18UsergridHttpMethod7baseUrlSS5pathsGSqGSaSS__5queryGSqCS_13UsergridQuery_4authGSqCS_12UsergridAuth_7headersGSqGVs10DictionarySSSS__8jsonBodyGSqPs9AnyObject__11queryParamsGSqGS4_SSSS___S0_">init(method:baseUrl:paths:query:auth:headers:jsonBody:queryParams:)</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/UsergridRequest.html">UsergridRequest</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">method</span><span class="p">:</span><span class="kt">UsergridHttpMethod</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">query</span><span class="p">:</span><span class="kt">UsergridQuery</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="nv">headers</span><span class="p">:[</span><span class="kt">String</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">jsonBody</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">queryParams</span><span class="p">:[</span><span class="kt">String</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>method</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP method.</p>
-
- </div>
- </td>
- </tr>
- <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>query</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional query to append to the 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>headers</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional headers.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>jsonBody</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional JSON body. Can be either a valid JSON object or NSData.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>queryParams</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional query params to be appended to the request url.</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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Instance%20Methods"></a>
- <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
- <a href="#/Instance%20Methods">
- <h3 class="section-name">Instance Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK15UsergridRequest17buildNSURLRequestFT_CSo12NSURLRequest"></a>
- <a name="//apple_ref/swift/Method/buildNSURLRequest()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK15UsergridRequest17buildNSURLRequestFT_CSo12NSURLRequest">buildNSURLRequest()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Constructs a <code>NSURLRequest</code> object with this objects instance properties.</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">buildNSURLRequest</span><span class="p">()</span> <span class="o">-></span> <span class="kt">NSURLRequest</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>An initialized and configured <code>NSURLRequest</code> object.</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>
[49/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/WatchSample Extension/InterfaceController.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/WatchSample Extension/InterfaceController.swift b/sdks/swift/Samples/ActivityFeed/WatchSample Extension/InterfaceController.swift
deleted file mode 100644
index a61192a..0000000
--- a/sdks/swift/Samples/ActivityFeed/WatchSample Extension/InterfaceController.swift
+++ /dev/null
@@ -1,81 +0,0 @@
-//
-// InterfaceController.swift
-// WatchSample Extension
-//
-// Created by Robert Walsh on 1/19/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import WatchKit
-import Foundation
-import UsergridSDK
-import WatchConnectivity
-
-class InterfaceController: WKInterfaceController,WCSessionDelegate {
-
- @IBOutlet var messageTable: WKInterfaceTable!
- var messageEntities: [ActivityEntity] = []
-
- override func awakeWithContext(context: AnyObject?) {
- super.awakeWithContext(context)
- if WCSession.isSupported() {
- let session = WCSession.defaultSession()
- session.delegate = self
- session.activateSession()
- }
- }
-
- override func willActivate() {
- self.reloadTable()
- if WCSession.defaultSession().reachable {
- WCSession.defaultSession().sendMessage(["action":"getMessages"], replyHandler: nil) { (error) -> Void in
- print(error)
- }
- }
- super.willActivate()
- }
-
- func reloadTable() {
- self.messageTable.setNumberOfRows(messageEntities.count, withRowType: "MessageRow")
- for index in 0..<self.messageTable.numberOfRows {
- if let controller = self.messageTable.rowControllerAtIndex(index) as? MessageRowController {
- let messageEntity = messageEntities[index]
- controller.titleLabel.setText(messageEntity.displayName)
- controller.messageLabel.setText(messageEntity.content)
- }
- }
- }
-
- func session(session: WCSession, didReceiveMessageData messageData: NSData) {
- NSKeyedUnarchiver.setClass(ActivityEntity.self, forClassName: "ActivityEntity")
- if let messageEntities = NSKeyedUnarchiver.unarchiveObjectWithData(messageData) as? [ActivityEntity] {
- self.messageEntities = messageEntities
- self.reloadTable()
- }
- }
-}
-
-class MessageRowController: NSObject {
-
- @IBOutlet var titleLabel: WKInterfaceLabel!
- @IBOutlet var messageLabel: WKInterfaceLabel!
-
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/WatchSample/Assets.xcassets/AppIcon.appiconset/Contents.json
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/WatchSample/Assets.xcassets/AppIcon.appiconset/Contents.json b/sdks/swift/Samples/ActivityFeed/WatchSample/Assets.xcassets/AppIcon.appiconset/Contents.json
deleted file mode 100644
index dd221ba..0000000
--- a/sdks/swift/Samples/ActivityFeed/WatchSample/Assets.xcassets/AppIcon.appiconset/Contents.json
+++ /dev/null
@@ -1,55 +0,0 @@
-{
- "images" : [
- {
- "size" : "24x24",
- "idiom" : "watch",
- "scale" : "2x",
- "role" : "notificationCenter",
- "subtype" : "38mm"
- },
- {
- "size" : "27.5x27.5",
- "idiom" : "watch",
- "scale" : "2x",
- "role" : "notificationCenter",
- "subtype" : "42mm"
- },
- {
- "size" : "29x29",
- "idiom" : "watch",
- "role" : "companionSettings",
- "scale" : "2x"
- },
- {
- "size" : "29x29",
- "idiom" : "watch",
- "role" : "companionSettings",
- "scale" : "3x"
- },
- {
- "size" : "40x40",
- "idiom" : "watch",
- "scale" : "2x",
- "role" : "appLauncher",
- "subtype" : "38mm"
- },
- {
- "size" : "86x86",
- "idiom" : "watch",
- "scale" : "2x",
- "role" : "quickLook",
- "subtype" : "38mm"
- },
- {
- "size" : "98x98",
- "idiom" : "watch",
- "scale" : "2x",
- "role" : "quickLook",
- "subtype" : "42mm"
- }
- ],
- "info" : {
- "version" : 1,
- "author" : "xcode"
- }
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/WatchSample/Base.lproj/Interface.storyboard
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/WatchSample/Base.lproj/Interface.storyboard b/sdks/swift/Samples/ActivityFeed/WatchSample/Base.lproj/Interface.storyboard
deleted file mode 100644
index 4e011dc..0000000
--- a/sdks/swift/Samples/ActivityFeed/WatchSample/Base.lproj/Interface.storyboard
+++ /dev/null
@@ -1,46 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<document type="com.apple.InterfaceBuilder.WatchKit.Storyboard" version="3.0" toolsVersion="9532" systemVersion="15D21" targetRuntime="watchKit" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" initialViewController="AgC-eL-Hgc">
- <dependencies>
- <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="9530"/>
- <plugIn identifier="com.apple.InterfaceBuilder.IBWatchKitPlugin" version="9515"/>
- </dependencies>
- <scenes>
- <!--Feed-->
- <scene sceneID="aou-V4-d1y">
- <objects>
- <controller title="Feed" spacing="10" id="AgC-eL-Hgc" customClass="InterfaceController" customModule="WatchSample" customModuleProvider="target">
- <items>
- <table alignment="left" spacing="0.0" id="gbs-i5-TZT">
- <items>
- <tableRow identifier="MessageRow" id="s77-Tk-Kwm" customClass="MessageRowController" customModule="WatchSample_Extension">
- <group key="rootItem" width="1" height="0.0" alignment="left" layout="vertical" spacing="6" id="7T9-to-Yec">
- <items>
- <separator alignment="left" id="T88-lA-wzU">
- <color key="color" red="1" green="1" blue="1" alpha="1" colorSpace="calibratedRGB"/>
- </separator>
- <label alignment="left" text="Label" numberOfLines="0" id="Moc-hL-RIQ">
- <color key="textColor" red="0.090196078430000007" green="0.33725490200000002" blue="0.50588235290000005" alpha="1" colorSpace="calibratedRGB"/>
- </label>
- <label width="119.5" alignment="left" text="Label" numberOfLines="0" id="uGF-56-y5z"/>
- <separator alignment="left" id="zwp-tp-Qaa">
- <color key="color" red="1" green="1" blue="1" alpha="1" colorSpace="calibratedRGB"/>
- </separator>
- </items>
- </group>
- <connections>
- <outlet property="messageLabel" destination="uGF-56-y5z" id="fOS-RF-6Yi"/>
- <outlet property="titleLabel" destination="Moc-hL-RIQ" id="9Hq-0v-bfG"/>
- </connections>
- </tableRow>
- </items>
- </table>
- </items>
- <connections>
- <outlet property="messageTable" destination="gbs-i5-TZT" id="b4D-hF-whq"/>
- </connections>
- </controller>
- </objects>
- <point key="canvasLocation" x="281" y="350"/>
- </scene>
- </scenes>
-</document>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/ActivityFeed/WatchSample/Info.plist
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/ActivityFeed/WatchSample/Info.plist b/sdks/swift/Samples/ActivityFeed/WatchSample/Info.plist
deleted file mode 100644
index b7ffbc1..0000000
--- a/sdks/swift/Samples/ActivityFeed/WatchSample/Info.plist
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
- <key>CFBundleDevelopmentRegion</key>
- <string>en</string>
- <key>CFBundleDisplayName</key>
- <string>ActivityFeed</string>
- <key>CFBundleExecutable</key>
- <string>$(EXECUTABLE_NAME)</string>
- <key>CFBundleIdentifier</key>
- <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
- <key>CFBundleInfoDictionaryVersion</key>
- <string>6.0</string>
- <key>CFBundleName</key>
- <string>$(PRODUCT_NAME)</string>
- <key>CFBundlePackageType</key>
- <string>APPL</string>
- <key>CFBundleShortVersionString</key>
- <string>1.0</string>
- <key>CFBundleSignature</key>
- <string>????</string>
- <key>CFBundleVersion</key>
- <string>1</string>
- <key>UISupportedInterfaceOrientations</key>
- <array>
- <string>UIInterfaceOrientationPortrait</string>
- <string>UIInterfaceOrientationPortraitUpsideDown</string>
- </array>
- <key>WKCompanionAppBundleIdentifier</key>
- <string>com.usergrid.activityfeed</string>
- <key>WKWatchKitApp</key>
- <true/>
-</dict>
-</plist>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Push.xcodeproj/project.pbxproj
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Push.xcodeproj/project.pbxproj b/sdks/swift/Samples/Push/Push.xcodeproj/project.pbxproj
deleted file mode 100644
index f786e4e..0000000
--- a/sdks/swift/Samples/Push/Push.xcodeproj/project.pbxproj
+++ /dev/null
@@ -1,473 +0,0 @@
-// !$*UTF8*$!
-{
- archiveVersion = 1;
- classes = {
- };
- objectVersion = 46;
- objects = {
-
-/* Begin PBXBuildFile section */
- 634855231C726A3B005FE016 /* UsergridSDK.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 634855161C726A2D005FE016 /* UsergridSDK.framework */; };
- 634855241C726A3B005FE016 /* UsergridSDK.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 634855161C726A2D005FE016 /* UsergridSDK.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
- 637A720E1C5BF8160056545A /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 637A72061C5BF8160056545A /* AppDelegate.swift */; };
- 637A720F1C5BF8160056545A /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 637A72071C5BF8160056545A /* Assets.xcassets */; };
- 637A72101C5BF8160056545A /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 637A72081C5BF8160056545A /* LaunchScreen.storyboard */; };
- 637A72111C5BF8160056545A /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 637A720A1C5BF8160056545A /* Main.storyboard */; };
- 637A72131C5BF8160056545A /* ViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 637A720D1C5BF8160056545A /* ViewController.swift */; };
- 637A72161C5C06270056545A /* UsergridManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 637A72151C5C06270056545A /* UsergridManager.swift */; };
-/* End PBXBuildFile section */
-
-/* Begin PBXContainerItemProxy section */
- 634855151C726A2D005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 63AF0E881BBC38FB009D4196;
- remoteInfo = "UsergridSDK iOS";
- };
- 634855171C726A2D005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 639B4BEB1C3DD6CF005E26E7;
- remoteInfo = "UsergridSDK watchOS";
- };
- 634855191C726A2D005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 63EE610B1C406E1600AFC2CF;
- remoteInfo = "UsergridSDK tvOS";
- };
- 6348551B1C726A2D005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 631920451C48436500F99E86;
- remoteInfo = "UsergridSDK OSX";
- };
- 6348551D1C726A2D005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 6319204B1C49BC0700F99E86;
- remoteInfo = UsergridSDK_TVOS_Tests;
- };
- 6348551F1C726A2D005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 630A219F1C49BFFC008BE87F;
- remoteInfo = UsergridSDK_OSX_Tests;
- };
- 634855211C726A2D005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 2;
- remoteGlobalIDString = 630A21B81C49C473008BE87F;
- remoteInfo = UsergridSDK_iOS_Tests;
- };
- 634855251C726A3B005FE016 /* PBXContainerItemProxy */ = {
- isa = PBXContainerItemProxy;
- containerPortal = 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */;
- proxyType = 1;
- remoteGlobalIDString = 63AF0E871BBC38FB009D4196;
- remoteInfo = "UsergridSDK iOS";
- };
-/* End PBXContainerItemProxy section */
-
-/* Begin PBXCopyFilesBuildPhase section */
- 634855271C726A3B005FE016 /* Embed Frameworks */ = {
- isa = PBXCopyFilesBuildPhase;
- buildActionMask = 2147483647;
- dstPath = "";
- dstSubfolderSpec = 10;
- files = (
- 634855241C726A3B005FE016 /* UsergridSDK.framework in Embed Frameworks */,
- );
- name = "Embed Frameworks";
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXCopyFilesBuildPhase section */
-
-/* Begin PBXFileReference section */
- 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = UsergridSDK.xcodeproj; path = ../../UsergridSDK.xcodeproj; sourceTree = "<group>"; };
- 637A71F01C5BF7B10056545A /* Push.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Push.app; sourceTree = BUILT_PRODUCTS_DIR; };
- 637A72061C5BF8160056545A /* AppDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
- 637A72071C5BF8160056545A /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
- 637A72091C5BF8160056545A /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = "<group>"; };
- 637A720B1C5BF8160056545A /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = "<group>"; };
- 637A720C1C5BF8160056545A /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
- 637A720D1C5BF8160056545A /* ViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ViewController.swift; sourceTree = "<group>"; };
- 637A72151C5C06270056545A /* UsergridManager.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsergridManager.swift; sourceTree = "<group>"; };
-/* End PBXFileReference section */
-
-/* Begin PBXFrameworksBuildPhase section */
- 637A71ED1C5BF7B10056545A /* Frameworks */ = {
- isa = PBXFrameworksBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 634855231C726A3B005FE016 /* UsergridSDK.framework in Frameworks */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXFrameworksBuildPhase section */
-
-/* Begin PBXGroup section */
- 6348550C1C726A2D005FE016 /* Products */ = {
- isa = PBXGroup;
- children = (
- 634855161C726A2D005FE016 /* UsergridSDK.framework */,
- 634855181C726A2D005FE016 /* UsergridSDK.framework */,
- 6348551A1C726A2D005FE016 /* UsergridSDK.framework */,
- 6348551C1C726A2D005FE016 /* UsergridSDK.framework */,
- 6348551E1C726A2D005FE016 /* UsergridSDK_TVOS_Tests.xctest */,
- 634855201C726A2D005FE016 /* UsergridSDK_OSX_Tests.xctest */,
- 634855221C726A2D005FE016 /* UsergridSDK_iOS_Tests.xctest */,
- );
- name = Products;
- sourceTree = "<group>";
- };
- 637A71E71C5BF7B10056545A = {
- isa = PBXGroup;
- children = (
- 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */,
- 637A72051C5BF8160056545A /* Source */,
- 637A71F11C5BF7B10056545A /* Products */,
- );
- sourceTree = "<group>";
- };
- 637A71F11C5BF7B10056545A /* Products */ = {
- isa = PBXGroup;
- children = (
- 637A71F01C5BF7B10056545A /* Push.app */,
- );
- name = Products;
- sourceTree = "<group>";
- };
- 637A72051C5BF8160056545A /* Source */ = {
- isa = PBXGroup;
- children = (
- 637A72061C5BF8160056545A /* AppDelegate.swift */,
- 637A720D1C5BF8160056545A /* ViewController.swift */,
- 637A72151C5C06270056545A /* UsergridManager.swift */,
- 637A720A1C5BF8160056545A /* Main.storyboard */,
- 637A72081C5BF8160056545A /* LaunchScreen.storyboard */,
- 637A72141C5BF8220056545A /* Supporting Files */,
- );
- path = Source;
- sourceTree = "<group>";
- };
- 637A72141C5BF8220056545A /* Supporting Files */ = {
- isa = PBXGroup;
- children = (
- 637A72071C5BF8160056545A /* Assets.xcassets */,
- 637A720C1C5BF8160056545A /* Info.plist */,
- );
- name = "Supporting Files";
- sourceTree = "<group>";
- };
-/* End PBXGroup section */
-
-/* Begin PBXNativeTarget section */
- 637A71EF1C5BF7B10056545A /* Push */ = {
- isa = PBXNativeTarget;
- buildConfigurationList = 637A72021C5BF7B10056545A /* Build configuration list for PBXNativeTarget "Push" */;
- buildPhases = (
- 637A71EC1C5BF7B10056545A /* Sources */,
- 637A71ED1C5BF7B10056545A /* Frameworks */,
- 637A71EE1C5BF7B10056545A /* Resources */,
- 634855271C726A3B005FE016 /* Embed Frameworks */,
- );
- buildRules = (
- );
- dependencies = (
- 634855261C726A3B005FE016 /* PBXTargetDependency */,
- );
- name = Push;
- productName = Push;
- productReference = 637A71F01C5BF7B10056545A /* Push.app */;
- productType = "com.apple.product-type.application";
- };
-/* End PBXNativeTarget section */
-
-/* Begin PBXProject section */
- 637A71E81C5BF7B10056545A /* Project object */ = {
- isa = PBXProject;
- attributes = {
- LastSwiftUpdateCheck = 0720;
- LastUpgradeCheck = 0720;
- ORGANIZATIONNAME = "Apigee Inc.";
- TargetAttributes = {
- 637A71EF1C5BF7B10056545A = {
- CreatedOnToolsVersion = 7.2;
- };
- };
- };
- buildConfigurationList = 637A71EB1C5BF7B10056545A /* Build configuration list for PBXProject "Push" */;
- compatibilityVersion = "Xcode 3.2";
- developmentRegion = English;
- hasScannedForEncodings = 0;
- knownRegions = (
- en,
- Base,
- );
- mainGroup = 637A71E71C5BF7B10056545A;
- productRefGroup = 637A71F11C5BF7B10056545A /* Products */;
- projectDirPath = "";
- projectReferences = (
- {
- ProductGroup = 6348550C1C726A2D005FE016 /* Products */;
- ProjectRef = 6348550B1C726A2D005FE016 /* UsergridSDK.xcodeproj */;
- },
- );
- projectRoot = "";
- targets = (
- 637A71EF1C5BF7B10056545A /* Push */,
- );
- };
-/* End PBXProject section */
-
-/* Begin PBXReferenceProxy section */
- 634855161C726A2D005FE016 /* UsergridSDK.framework */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.framework;
- path = UsergridSDK.framework;
- remoteRef = 634855151C726A2D005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 634855181C726A2D005FE016 /* UsergridSDK.framework */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.framework;
- path = UsergridSDK.framework;
- remoteRef = 634855171C726A2D005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 6348551A1C726A2D005FE016 /* UsergridSDK.framework */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.framework;
- path = UsergridSDK.framework;
- remoteRef = 634855191C726A2D005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 6348551C1C726A2D005FE016 /* UsergridSDK.framework */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.framework;
- path = UsergridSDK.framework;
- remoteRef = 6348551B1C726A2D005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 6348551E1C726A2D005FE016 /* UsergridSDK_TVOS_Tests.xctest */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.cfbundle;
- path = UsergridSDK_TVOS_Tests.xctest;
- remoteRef = 6348551D1C726A2D005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 634855201C726A2D005FE016 /* UsergridSDK_OSX_Tests.xctest */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.cfbundle;
- path = UsergridSDK_OSX_Tests.xctest;
- remoteRef = 6348551F1C726A2D005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
- 634855221C726A2D005FE016 /* UsergridSDK_iOS_Tests.xctest */ = {
- isa = PBXReferenceProxy;
- fileType = wrapper.cfbundle;
- path = UsergridSDK_iOS_Tests.xctest;
- remoteRef = 634855211C726A2D005FE016 /* PBXContainerItemProxy */;
- sourceTree = BUILT_PRODUCTS_DIR;
- };
-/* End PBXReferenceProxy section */
-
-/* Begin PBXResourcesBuildPhase section */
- 637A71EE1C5BF7B10056545A /* Resources */ = {
- isa = PBXResourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 637A72111C5BF8160056545A /* Main.storyboard in Resources */,
- 637A720F1C5BF8160056545A /* Assets.xcassets in Resources */,
- 637A72101C5BF8160056545A /* LaunchScreen.storyboard in Resources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXResourcesBuildPhase section */
-
-/* Begin PBXSourcesBuildPhase section */
- 637A71EC1C5BF7B10056545A /* Sources */ = {
- isa = PBXSourcesBuildPhase;
- buildActionMask = 2147483647;
- files = (
- 637A72161C5C06270056545A /* UsergridManager.swift in Sources */,
- 637A72131C5BF8160056545A /* ViewController.swift in Sources */,
- 637A720E1C5BF8160056545A /* AppDelegate.swift in Sources */,
- );
- runOnlyForDeploymentPostprocessing = 0;
- };
-/* End PBXSourcesBuildPhase section */
-
-/* Begin PBXTargetDependency section */
- 634855261C726A3B005FE016 /* PBXTargetDependency */ = {
- isa = PBXTargetDependency;
- name = "UsergridSDK iOS";
- targetProxy = 634855251C726A3B005FE016 /* PBXContainerItemProxy */;
- };
-/* End PBXTargetDependency section */
-
-/* Begin PBXVariantGroup section */
- 637A72081C5BF8160056545A /* LaunchScreen.storyboard */ = {
- isa = PBXVariantGroup;
- children = (
- 637A72091C5BF8160056545A /* Base */,
- );
- name = LaunchScreen.storyboard;
- sourceTree = "<group>";
- };
- 637A720A1C5BF8160056545A /* Main.storyboard */ = {
- isa = PBXVariantGroup;
- children = (
- 637A720B1C5BF8160056545A /* Base */,
- );
- name = Main.storyboard;
- sourceTree = "<group>";
- };
-/* End PBXVariantGroup section */
-
-/* Begin XCBuildConfiguration section */
- 637A72001C5BF7B10056545A /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ALWAYS_SEARCH_USER_PATHS = NO;
- CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
- CLANG_CXX_LIBRARY = "libc++";
- CLANG_ENABLE_MODULES = YES;
- CLANG_ENABLE_OBJC_ARC = YES;
- CLANG_WARN_BOOL_CONVERSION = YES;
- CLANG_WARN_CONSTANT_CONVERSION = YES;
- CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
- CLANG_WARN_EMPTY_BODY = YES;
- CLANG_WARN_ENUM_CONVERSION = YES;
- CLANG_WARN_INT_CONVERSION = YES;
- CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
- CLANG_WARN_UNREACHABLE_CODE = YES;
- CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- COPY_PHASE_STRIP = NO;
- DEBUG_INFORMATION_FORMAT = dwarf;
- ENABLE_STRICT_OBJC_MSGSEND = YES;
- ENABLE_TESTABILITY = YES;
- GCC_C_LANGUAGE_STANDARD = gnu99;
- GCC_DYNAMIC_NO_PIC = NO;
- GCC_NO_COMMON_BLOCKS = YES;
- GCC_OPTIMIZATION_LEVEL = 0;
- GCC_PREPROCESSOR_DEFINITIONS = (
- "DEBUG=1",
- "$(inherited)",
- );
- GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
- GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
- GCC_WARN_UNDECLARED_SELECTOR = YES;
- GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
- GCC_WARN_UNUSED_FUNCTION = YES;
- GCC_WARN_UNUSED_VARIABLE = YES;
- IPHONEOS_DEPLOYMENT_TARGET = 9.2;
- MTL_ENABLE_DEBUG_INFO = YES;
- ONLY_ACTIVE_ARCH = YES;
- SDKROOT = iphoneos;
- SWIFT_OPTIMIZATION_LEVEL = "-Onone";
- };
- name = Debug;
- };
- 637A72011C5BF7B10056545A /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ALWAYS_SEARCH_USER_PATHS = NO;
- CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
- CLANG_CXX_LIBRARY = "libc++";
- CLANG_ENABLE_MODULES = YES;
- CLANG_ENABLE_OBJC_ARC = YES;
- CLANG_WARN_BOOL_CONVERSION = YES;
- CLANG_WARN_CONSTANT_CONVERSION = YES;
- CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
- CLANG_WARN_EMPTY_BODY = YES;
- CLANG_WARN_ENUM_CONVERSION = YES;
- CLANG_WARN_INT_CONVERSION = YES;
- CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
- CLANG_WARN_UNREACHABLE_CODE = YES;
- CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- COPY_PHASE_STRIP = NO;
- DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
- ENABLE_NS_ASSERTIONS = NO;
- ENABLE_STRICT_OBJC_MSGSEND = YES;
- GCC_C_LANGUAGE_STANDARD = gnu99;
- GCC_NO_COMMON_BLOCKS = YES;
- GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
- GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
- GCC_WARN_UNDECLARED_SELECTOR = YES;
- GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
- GCC_WARN_UNUSED_FUNCTION = YES;
- GCC_WARN_UNUSED_VARIABLE = YES;
- IPHONEOS_DEPLOYMENT_TARGET = 9.2;
- MTL_ENABLE_DEBUG_INFO = NO;
- SDKROOT = iphoneos;
- VALIDATE_PRODUCT = YES;
- };
- name = Release;
- };
- 637A72031C5BF7B10056545A /* Debug */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
- INFOPLIST_FILE = Source/Info.plist;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = com.usergrid.usergridpushsample;
- PRODUCT_NAME = "$(TARGET_NAME)";
- PROVISIONING_PROFILE = "";
- };
- name = Debug;
- };
- 637A72041C5BF7B10056545A /* Release */ = {
- isa = XCBuildConfiguration;
- buildSettings = {
- ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
- CODE_SIGN_IDENTITY = "iPhone Developer";
- "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
- EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
- INFOPLIST_FILE = Source/Info.plist;
- LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
- PRODUCT_BUNDLE_IDENTIFIER = com.usergrid.usergridpushsample;
- PRODUCT_NAME = "$(TARGET_NAME)";
- PROVISIONING_PROFILE = "";
- };
- name = Release;
- };
-/* End XCBuildConfiguration section */
-
-/* Begin XCConfigurationList section */
- 637A71EB1C5BF7B10056545A /* Build configuration list for PBXProject "Push" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 637A72001C5BF7B10056545A /* Debug */,
- 637A72011C5BF7B10056545A /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
- 637A72021C5BF7B10056545A /* Build configuration list for PBXNativeTarget "Push" */ = {
- isa = XCConfigurationList;
- buildConfigurations = (
- 637A72031C5BF7B10056545A /* Debug */,
- 637A72041C5BF7B10056545A /* Release */,
- );
- defaultConfigurationIsVisible = 0;
- defaultConfigurationName = Release;
- };
-/* End XCConfigurationList section */
- };
- rootObject = 637A71E81C5BF7B10056545A /* Project object */;
-}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Push.xcodeproj/project.xcworkspace/contents.xcworkspacedata
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Push.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/sdks/swift/Samples/Push/Push.xcodeproj/project.xcworkspace/contents.xcworkspacedata
deleted file mode 100644
index 5ff4e01..0000000
--- a/sdks/swift/Samples/Push/Push.xcodeproj/project.xcworkspace/contents.xcworkspacedata
+++ /dev/null
@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
- version = "1.0">
- <FileRef
- location = "self:Push.xcodeproj">
- </FileRef>
-</Workspace>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Push.xcworkspace/contents.xcworkspacedata
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Push.xcworkspace/contents.xcworkspacedata b/sdks/swift/Samples/Push/Push.xcworkspace/contents.xcworkspacedata
deleted file mode 100644
index 268a2da..0000000
--- a/sdks/swift/Samples/Push/Push.xcworkspace/contents.xcworkspacedata
+++ /dev/null
@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
- version = "1.0">
- <FileRef
- location = "group:Push.xcodeproj">
- </FileRef>
-</Workspace>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Readme.md
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Readme.md b/sdks/swift/Samples/Push/Readme.md
deleted file mode 100644
index 488509c..0000000
--- a/sdks/swift/Samples/Push/Readme.md
+++ /dev/null
@@ -1,21 +0,0 @@
-#Push
-
-## Running the Sample
-
-To run the sample app, simply open the `Push.xcworkspace` file in Xcode.
-
-Two targets in Xcode specific to this application will be available:
-
-- **Push Target**
-
- This will run the iOS sample application.
-
-##Configuring the Sample Apps
-
-Before running the sample applications you will need to configure each sample application.
-
-Each sample application should include a source file named `UsergridManager.swift`. This source file is used to contain interaction with the UsergridSDK within a single source file. In doing so, the interactions within the sample apps can be easily seen and examined.
-
-Within the `UsergridManager.swift` source there will be at least two different static vars named `ORG_ID` and `APP_ID`. You will need to configure those values in order to run the applications in your environment.
-
-Applications which utilize push notifications will require a valid provisioning profile and device for the push services to work correctly.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Source/AppDelegate.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Source/AppDelegate.swift b/sdks/swift/Samples/Push/Source/AppDelegate.swift
deleted file mode 100644
index 0ce64dd..0000000
--- a/sdks/swift/Samples/Push/Source/AppDelegate.swift
+++ /dev/null
@@ -1,53 +0,0 @@
-//
-// AppDelegate.swift
-// Push
-//
-// Created by Robert Walsh on 1/29/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import UIKit
-import UsergridSDK
-
-@UIApplicationMain
-class AppDelegate: UIResponder, UIApplicationDelegate {
-
- var window: UIWindow?
-
- func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
-
- UsergridManager.initializeSharedInstance()
-
- application.registerUserNotificationSettings(UIUserNotificationSettings( forTypes: [.Alert, .Badge, .Sound], categories: nil))
- application.registerForRemoteNotifications()
-
- return true
- }
-
- func application(application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: NSData) {
- UsergridManager.applyPushToken(deviceToken)
- }
-
- func application(application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: NSError) {
- print("Application failed to register for remote notifications")
- }
-}
-
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Source/Assets.xcassets/AppIcon.appiconset/Contents.json
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Source/Assets.xcassets/AppIcon.appiconset/Contents.json b/sdks/swift/Samples/Push/Source/Assets.xcassets/AppIcon.appiconset/Contents.json
deleted file mode 100644
index 118c98f..0000000
--- a/sdks/swift/Samples/Push/Source/Assets.xcassets/AppIcon.appiconset/Contents.json
+++ /dev/null
@@ -1,38 +0,0 @@
-{
- "images" : [
- {
- "idiom" : "iphone",
- "size" : "29x29",
- "scale" : "2x"
- },
- {
- "idiom" : "iphone",
- "size" : "29x29",
- "scale" : "3x"
- },
- {
- "idiom" : "iphone",
- "size" : "40x40",
- "scale" : "2x"
- },
- {
- "idiom" : "iphone",
- "size" : "40x40",
- "scale" : "3x"
- },
- {
- "idiom" : "iphone",
- "size" : "60x60",
- "scale" : "2x"
- },
- {
- "idiom" : "iphone",
- "size" : "60x60",
- "scale" : "3x"
- }
- ],
- "info" : {
- "version" : 1,
- "author" : "xcode"
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Source/Assets.xcassets/Contents.json
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Source/Assets.xcassets/Contents.json b/sdks/swift/Samples/Push/Source/Assets.xcassets/Contents.json
deleted file mode 100644
index da4a164..0000000
--- a/sdks/swift/Samples/Push/Source/Assets.xcassets/Contents.json
+++ /dev/null
@@ -1,6 +0,0 @@
-{
- "info" : {
- "version" : 1,
- "author" : "xcode"
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Source/Assets.xcassets/UsergridGuy.imageset/Contents.json
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Source/Assets.xcassets/UsergridGuy.imageset/Contents.json b/sdks/swift/Samples/Push/Source/Assets.xcassets/UsergridGuy.imageset/Contents.json
deleted file mode 100644
index c19ad83..0000000
--- a/sdks/swift/Samples/Push/Source/Assets.xcassets/UsergridGuy.imageset/Contents.json
+++ /dev/null
@@ -1,21 +0,0 @@
-{
- "images" : [
- {
- "idiom" : "universal",
- "filename" : "UsergridGuy.png",
- "scale" : "1x"
- },
- {
- "idiom" : "universal",
- "scale" : "2x"
- },
- {
- "idiom" : "universal",
- "scale" : "3x"
- }
- ],
- "info" : {
- "version" : 1,
- "author" : "xcode"
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Source/Assets.xcassets/UsergridGuy.imageset/UsergridGuy.png
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Source/Assets.xcassets/UsergridGuy.imageset/UsergridGuy.png b/sdks/swift/Samples/Push/Source/Assets.xcassets/UsergridGuy.imageset/UsergridGuy.png
deleted file mode 100644
index b8a6844..0000000
Binary files a/sdks/swift/Samples/Push/Source/Assets.xcassets/UsergridGuy.imageset/UsergridGuy.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Source/Base.lproj/LaunchScreen.storyboard
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Source/Base.lproj/LaunchScreen.storyboard b/sdks/swift/Samples/Push/Source/Base.lproj/LaunchScreen.storyboard
deleted file mode 100644
index 8326657..0000000
--- a/sdks/swift/Samples/Push/Source/Base.lproj/LaunchScreen.storyboard
+++ /dev/null
@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="9531" systemVersion="15D21" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" launchScreen="YES" useTraitCollections="YES" initialViewController="01J-lp-oVM">
- <dependencies>
- <deployment identifier="iOS"/>
- <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="9529"/>
- </dependencies>
- <scenes>
- <!--View Controller-->
- <scene sceneID="EHf-IW-A2E">
- <objects>
- <viewController id="01J-lp-oVM" sceneMemberID="viewController">
- <layoutGuides>
- <viewControllerLayoutGuide type="top" id="Llm-lL-Icb"/>
- <viewControllerLayoutGuide type="bottom" id="xb3-aO-Qok"/>
- </layoutGuides>
- <view key="view" contentMode="scaleToFill" id="Ze5-6b-2t3">
- <rect key="frame" x="0.0" y="0.0" width="600" height="600"/>
- <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
- <color key="backgroundColor" white="1" alpha="1" colorSpace="custom" customColorSpace="calibratedWhite"/>
- </view>
- </viewController>
- <placeholder placeholderIdentifier="IBFirstResponder" id="iYj-Kq-Ea1" userLabel="First Responder" sceneMemberID="firstResponder"/>
- </objects>
- <point key="canvasLocation" x="53" y="375"/>
- </scene>
- </scenes>
-</document>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Source/Base.lproj/Main.storyboard
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Source/Base.lproj/Main.storyboard b/sdks/swift/Samples/Push/Source/Base.lproj/Main.storyboard
deleted file mode 100644
index f1d2558..0000000
--- a/sdks/swift/Samples/Push/Source/Base.lproj/Main.storyboard
+++ /dev/null
@@ -1,75 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="9531" systemVersion="15D21" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" initialViewController="BYZ-38-t0r">
- <dependencies>
- <deployment identifier="iOS"/>
- <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="9529"/>
- <capability name="Constraints to layout margins" minToolsVersion="6.0"/>
- </dependencies>
- <scenes>
- <!--View Controller-->
- <scene sceneID="tne-QT-ifu">
- <objects>
- <viewController id="BYZ-38-t0r" customClass="ViewController" customModule="Push" customModuleProvider="target" sceneMemberID="viewController">
- <layoutGuides>
- <viewControllerLayoutGuide type="top" id="y3c-jy-aDJ"/>
- <viewControllerLayoutGuide type="bottom" id="wfy-db-euE"/>
- </layoutGuides>
- <view key="view" contentMode="scaleToFill" id="8bC-Xf-vdC">
- <rect key="frame" x="0.0" y="0.0" width="414" height="736"/>
- <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
- <subviews>
- <imageView userInteractionEnabled="NO" contentMode="scaleToFill" horizontalHuggingPriority="251" verticalHuggingPriority="251" image="UsergridGuy" translatesAutoresizingMaskIntoConstraints="NO" id="SlS-IJ-WvF">
- <rect key="frame" x="102" y="263" width="210" height="210"/>
- </imageView>
- <button opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="WKX-zU-FkH">
- <rect key="frame" x="102" y="45" width="210" height="210"/>
- <color key="backgroundColor" red="1" green="1" blue="1" alpha="0.59999999999999998" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstAttribute="height" constant="210" id="Lip-pm-tI5"/>
- </constraints>
- <state key="normal" title="push to this device">
- <color key="titleColor" red="1" green="1" blue="1" alpha="1" colorSpace="calibratedRGB"/>
- <color key="titleShadowColor" white="0.5" alpha="1" colorSpace="calibratedWhite"/>
- </state>
- <connections>
- <action selector="pushToThisDevice:" destination="BYZ-38-t0r" eventType="touchUpInside" id="PyU-Dy-zGg"/>
- </connections>
- </button>
- <button opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="HVf-R4-fSL">
- <rect key="frame" x="102" y="481" width="210" height="210"/>
- <color key="backgroundColor" red="1" green="1" blue="1" alpha="0.59999999999999998" colorSpace="calibratedRGB"/>
- <state key="normal" title="push to all devices">
- <color key="titleColor" red="1" green="1" blue="1" alpha="1" colorSpace="calibratedRGB"/>
- <color key="titleShadowColor" white="0.5" alpha="1" colorSpace="calibratedWhite"/>
- </state>
- <connections>
- <action selector="pushToAllDevices:" destination="BYZ-38-t0r" eventType="touchUpInside" id="j7d-n8-KeM"/>
- </connections>
- </button>
- </subviews>
- <color key="backgroundColor" red="0.10196078431372549" green="0.42745098039215684" blue="0.59215686274509804" alpha="1" colorSpace="calibratedRGB"/>
- <constraints>
- <constraint firstItem="WKX-zU-FkH" firstAttribute="trailing" secondItem="SlS-IJ-WvF" secondAttribute="trailing" id="143-qW-0PZ"/>
- <constraint firstItem="HVf-R4-fSL" firstAttribute="leading" secondItem="SlS-IJ-WvF" secondAttribute="leading" id="3qa-G1-lcp"/>
- <constraint firstItem="SlS-IJ-WvF" firstAttribute="centerX" secondItem="8bC-Xf-vdC" secondAttribute="centerX" id="6oN-Cy-5xc"/>
- <constraint firstItem="wfy-db-euE" firstAttribute="top" secondItem="HVf-R4-fSL" secondAttribute="bottom" constant="45" id="7Oq-1b-BlW"/>
- <constraint firstItem="SlS-IJ-WvF" firstAttribute="top" secondItem="WKX-zU-FkH" secondAttribute="bottom" constant="8" symbolic="YES" id="B0h-XG-3pm"/>
- <constraint firstItem="SlS-IJ-WvF" firstAttribute="centerY" secondItem="8bC-Xf-vdC" secondAttribute="centerY" id="Hbg-BY-chR"/>
- <constraint firstItem="SlS-IJ-WvF" firstAttribute="trailing" secondItem="HVf-R4-fSL" secondAttribute="trailing" id="KLV-Bs-7HU"/>
- <constraint firstItem="WKX-zU-FkH" firstAttribute="leading" secondItem="8bC-Xf-vdC" secondAttribute="leadingMargin" constant="82" id="UDK-2x-rwK"/>
- <constraint firstItem="HVf-R4-fSL" firstAttribute="top" secondItem="SlS-IJ-WvF" secondAttribute="bottom" constant="8" symbolic="YES" id="bBV-SP-lGh"/>
- <constraint firstItem="WKX-zU-FkH" firstAttribute="top" secondItem="y3c-jy-aDJ" secondAttribute="bottom" constant="25" id="eh3-3a-qhv"/>
- <constraint firstItem="WKX-zU-FkH" firstAttribute="leading" secondItem="SlS-IJ-WvF" secondAttribute="leading" id="gZr-gE-TxI"/>
- </constraints>
- </view>
- <simulatedScreenMetrics key="simulatedDestinationMetrics" type="retina55"/>
- </viewController>
- <placeholder placeholderIdentifier="IBFirstResponder" id="dkx-z0-nzr" sceneMemberID="firstResponder"/>
- </objects>
- <point key="canvasLocation" x="335" y="350"/>
- </scene>
- </scenes>
- <resources>
- <image name="UsergridGuy" width="162" height="161"/>
- </resources>
-</document>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Source/Info.plist
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Source/Info.plist b/sdks/swift/Samples/Push/Source/Info.plist
deleted file mode 100644
index 6c48029..0000000
--- a/sdks/swift/Samples/Push/Source/Info.plist
+++ /dev/null
@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
- <key>CFBundleDevelopmentRegion</key>
- <string>en</string>
- <key>CFBundleExecutable</key>
- <string>$(EXECUTABLE_NAME)</string>
- <key>CFBundleIdentifier</key>
- <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
- <key>CFBundleInfoDictionaryVersion</key>
- <string>6.0</string>
- <key>CFBundleName</key>
- <string>$(PRODUCT_NAME)</string>
- <key>CFBundlePackageType</key>
- <string>APPL</string>
- <key>CFBundleShortVersionString</key>
- <string>1.0</string>
- <key>CFBundleSignature</key>
- <string>????</string>
- <key>CFBundleVersion</key>
- <string>1</string>
- <key>LSRequiresIPhoneOS</key>
- <true/>
- <key>UILaunchStoryboardName</key>
- <string>LaunchScreen</string>
- <key>UIMainStoryboardFile</key>
- <string>Main</string>
- <key>UIRequiredDeviceCapabilities</key>
- <array>
- <string>armv7</string>
- </array>
- <key>UISupportedInterfaceOrientations</key>
- <array>
- <string>UIInterfaceOrientationPortrait</string>
- </array>
-</dict>
-</plist>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Source/UsergridManager.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Source/UsergridManager.swift b/sdks/swift/Samples/Push/Source/UsergridManager.swift
deleted file mode 100644
index 00e8ec2..0000000
--- a/sdks/swift/Samples/Push/Source/UsergridManager.swift
+++ /dev/null
@@ -1,72 +0,0 @@
-//
-// UsergridManager.swift
-// Push
-//
-// Created by Robert Walsh on 1/19/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import Foundation
-import UsergridSDK
-
-/// This class handles the primary communications to the UsergridSDK.
-public class UsergridManager {
-
- static let ORG_ID = "rwalsh"
- static let APP_ID = "sandbox"
- static let NOTIFIER_ID = "usergridpushsample"
- static let BASE_URL = "https://api.usergrid.com"
-
- static func initializeSharedInstance() {
- Usergrid.initSharedInstance(configuration: UsergridClientConfig(orgId: UsergridManager.ORG_ID, appId: UsergridManager.APP_ID, baseUrl: UsergridManager.BASE_URL))
- }
-
- static func applyPushToken(deviceToken:NSData) {
- Usergrid.applyPushToken(deviceToken, notifierID: UsergridManager.NOTIFIER_ID, completion: { (response) -> Void in
- print("Apply token completed successfully : \(response.ok)")
- if !response.ok, let errorDescription = response.error?.errorDescription {
- print("Error Description : \(errorDescription)")
- }
- })
- }
-
- static func sendPush(deviceId deviceId:String,message:String) {
- let pushRequest = UsergridRequest(method: .Post,
- baseUrl: Usergrid.clientAppURL,
- paths: ["devices",deviceId,"notifications"],
- auth: Usergrid.authForRequests(),
- jsonBody: ["payloads":[UsergridManager.NOTIFIER_ID:message]])
- Usergrid.sendRequest(pushRequest, completion: { (response) -> Void in
- print("Push request completed successfully : \(response.ok)")
- if !response.ok, let errorDescription = response.error?.errorDescription {
- print("Error Description : \(errorDescription)")
- }
- })
- }
-
- static func pushToThisDevice() {
- UsergridManager.sendPush(deviceId: UsergridDevice.sharedDevice.uuid!, message: "Push to this device message.")
- }
-
- static func pushToAllDevices() {
- UsergridManager.sendPush(deviceId: "*", message: "Push to all devices message.")
- }
-}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Push/Source/ViewController.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Push/Source/ViewController.swift b/sdks/swift/Samples/Push/Source/ViewController.swift
deleted file mode 100644
index d1e3247..0000000
--- a/sdks/swift/Samples/Push/Source/ViewController.swift
+++ /dev/null
@@ -1,39 +0,0 @@
-//
-// ViewController.swift
-// Push
-//
-// Created by Robert Walsh on 1/29/16.
-//
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. The ASF licenses this file to You
- * under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. For additional information regarding
- * copyright in this work, please see the NOTICE file in the top level
- * directory of this distribution.
- *
- */
-
-import UIKit
-
-class ViewController: UIViewController {
-
- @IBAction func pushToThisDevice(sender: AnyObject) {
- UsergridManager.pushToThisDevice()
- }
-
- @IBAction func pushToAllDevices(sender: AnyObject) {
- UsergridManager.pushToAllDevices()
- }
-}
-
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Samples/Readme.md
----------------------------------------------------------------------
diff --git a/sdks/swift/Samples/Readme.md b/sdks/swift/Samples/Readme.md
deleted file mode 100644
index fbfacdb..0000000
--- a/sdks/swift/Samples/Readme.md
+++ /dev/null
@@ -1,27 +0,0 @@
-#UsergridSDK Sample Apps
-
-The sample apps in this directory are intended to show basic usage of some of the major features of the UsergridSDK.
-
-> Each sample application installs the UsergridSDK by embedding the framework directly. A sample application integrating the UsergridSDK via `Cocoapods` will be coming in the near future.
-
-##Samples Apps
-
-* **ActivityFeed** - An app that demonstrates a wide variety of operations within the SDK. This app also contains a companion WatchOS application.
-
-* **Push** - An app that registers for and sends push notifications.
-
-## Running the Sample Apps
-
-To run the sample apps, simply open the `<SAMPLE APP NAME>.xcworkspace` file in Xcode, then run the app.
-
-> Note that some applications utilize `Cocoapods` (such as the `ActivityFeed` sample) and you will need to run the `$ pod install` command from within the root folder of the sample project in order for the sample to run properly.
-
-##Configuring the Sample Apps
-
-Before running the sample applications you will need to configure each sample application.
-
-Each sample application should include a source file named `UsergridManager.swift`. This source file is used to contain interaction with the UsergridSDK within a single source file. In doing so, the interactions within the sample apps can be easily seen and examined.
-
-Within the `UsergridManager.swift` source there will be at least two different static vars named `ORG_ID` and `APP_ID`. You will need to configure those values in order to run the applications in your environment.
-
-Applications which utilize push notifications will require a valid provisioning profile and device for the push services to work correctly.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/Source/Info.plist
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/Info.plist b/sdks/swift/Source/Info.plist
deleted file mode 100644
index d3de8ee..0000000
--- a/sdks/swift/Source/Info.plist
+++ /dev/null
@@ -1,26 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
- <key>CFBundleDevelopmentRegion</key>
- <string>en</string>
- <key>CFBundleExecutable</key>
- <string>$(EXECUTABLE_NAME)</string>
- <key>CFBundleIdentifier</key>
- <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
- <key>CFBundleInfoDictionaryVersion</key>
- <string>6.0</string>
- <key>CFBundleName</key>
- <string>$(PRODUCT_NAME)</string>
- <key>CFBundlePackageType</key>
- <string>FMWK</string>
- <key>CFBundleShortVersionString</key>
- <string>1.0</string>
- <key>CFBundleSignature</key>
- <string>????</string>
- <key>CFBundleVersion</key>
- <string>$(CURRENT_PROJECT_VERSION)</string>
- <key>NSPrincipalClass</key>
- <string></string>
-</dict>
-</plist>
[40/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridAuth.html b/sdks/swift/docs/Classes/UsergridAuth.html
deleted file mode 100644
index 8d1f6fd..0000000
--- a/sdks/swift/docs/Classes/UsergridAuth.html
+++ /dev/null
@@ -1,558 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAuth 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/UsergridAuth" class="dashAnchor"></a>
- <a title="UsergridAuth 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" />
- UsergridAuth 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>UsergridAuth</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p>The <code>UsergridAuth</code> class functions to create and store authentication information used by Usergrid.</p>
-
-<p>The <code>UsergridAuth</code> sub classes, <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> and <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code>, provide different ways for authentication to be used in creating requests for access tokens through the SDK.</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:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_"></a>
- <a name="//apple_ref/swift/Property/accessToken" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The access token, if this <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> was authorized successfully.</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">accessToken</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:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_"></a>
- <a name="//apple_ref/swift/Property/expiry" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_">expiry</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The expires at date, if this <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> was authorized successfully and their was a expires in time stamp within the token response.</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">expiry</span> <span class="p">:</span> <span class="kt">NSDate</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridAuth8hasTokenSb"></a>
- <a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth8hasTokenSb">hasToken</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if an access token exists.</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">hasToken</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">accessToken</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridAuth7isValidSb"></a>
- <a name="//apple_ref/swift/Property/isValid" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth7isValidSb">isValid</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if an access token exists and if the token is not expired.</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">isValid</span> <span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">hasToken</span> <span class="o">&&</span> <span class="o">!</span><span class="k">self</span><span class="o">.</span><span class="n">isExpired</span> <span class="p">}</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK12UsergridAuth9isExpiredSb"></a>
- <a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth9isExpiredSb">isExpired</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Determines if the access token, if one exists, is expired.</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">isExpired</span><span class="p">:</span> <span class="kt">Bool</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:FC11UsergridSDK12UsergridAuthcFT11accessTokenSS6expiryGSqCSo6NSDate__S0_"></a>
- <a name="//apple_ref/swift/Method/init(accessToken:expiry:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFT11accessTokenSS6expiryGSqCSo6NSDate__S0_">init(accessToken:expiry:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializer for a base <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object that just contains an <code><a href="../Classes/UsergridAuth.html#/s:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a></code> and an optional <code><a href="../Classes/UsergridAuth.html#/s:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_">expiry</a></code> date.</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">accessToken</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">expiry</span><span class="p">:</span><span class="kt">NSDate</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>accessToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The access token.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>expiry</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional expiry date.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridAuth.html">UsergridAuth</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:FC11UsergridSDK12UsergridAuthcFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFT5coderCSo7NSCoder_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/UsergridAuth.html">UsergridAuth</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridAuth15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuth15encodeWithCoderFCSo7NSCoderT_">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>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Instance%20Methods"></a>
- <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
- <a href="#/Instance%20Methods">
- <h3 class="section-name">Instance Methods</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK12UsergridAuth7destroyFT_T_"></a>
- <a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuth7destroyFT_T_">destroy()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Destroys/removes the access token and expiry.</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">destroy</span><span class="p">()</span></code></pre>
-
- </div>
- </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>
[36/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
Posted by mr...@apache.org.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridFileMetaData.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridFileMetaData.html b/sdks/swift/docs/Classes/UsergridFileMetaData.html
deleted file mode 100644
index 1cc8ccf..0000000
--- a/sdks/swift/docs/Classes/UsergridFileMetaData.html
+++ /dev/null
@@ -1,532 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridFileMetaData 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/UsergridFileMetaData" class="dashAnchor"></a>
- <a title="UsergridFileMetaData 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" />
- UsergridFileMetaData 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>UsergridFileMetaData</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridFileMetaData</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span><span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p><code>UsergridFileMetaData</code> is a helper class for dealing with reading <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> file meta data.</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:vC11UsergridSDK20UsergridFileMetaData4eTagGSqSS_"></a>
- <a name="//apple_ref/swift/Property/eTag" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData4eTagGSqSS_">eTag</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The eTag.</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">eTag</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:vC11UsergridSDK20UsergridFileMetaData8checkSumGSqSS_"></a>
- <a name="//apple_ref/swift/Property/checkSum" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData8checkSumGSqSS_">checkSum</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The check sum.</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">checkSum</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:vC11UsergridSDK20UsergridFileMetaData11contentTypeGSqSS_"></a>
- <a name="//apple_ref/swift/Property/contentType" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData11contentTypeGSqSS_">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 associated with the file 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">contentType</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:vC11UsergridSDK20UsergridFileMetaData13contentLengthSi"></a>
- <a name="//apple_ref/swift/Property/contentLength" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData13contentLengthSi">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 file 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">contentLength</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK20UsergridFileMetaData21lastModifiedTimeStampSi"></a>
- <a name="//apple_ref/swift/Property/lastModifiedTimeStamp" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData21lastModifiedTimeStampSi">lastModifiedTimeStamp</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The last modified time stamp.</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">lastModifiedTimeStamp</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK20UsergridFileMetaData16lastModifiedDateGSqCSo6NSDate_"></a>
- <a name="//apple_ref/swift/Property/lastModifiedDate" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK20UsergridFileMetaData16lastModifiedDateGSqCSo6NSDate_">lastModifiedDate</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code><a href="../Extensions/NSDate.html">NSDate</a></code> object corresponding to the last modified time stamp.</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">lastModifiedDate</span><span class="p">:</span> <span class="kt">NSDate</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:FC11UsergridSDK20UsergridFileMetaDatacFT16fileMetaDataJSONGVs10DictionarySSPs9AnyObject___S0_"></a>
- <a name="//apple_ref/swift/Method/init(fileMetaDataJSON:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridFileMetaDatacFT16fileMetaDataJSONGVs10DictionarySSPs9AnyObject___S0_">init(fileMetaDataJSON:)</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/UsergridFileMetaData.html">UsergridFileMetaData</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">fileMetaDataJSON</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">])</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>fileMetaDataJSON</em>
- </code>
- </td>
- <td>
- <div>
- <p>The file meta data JSON dictionary.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</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:FC11UsergridSDK20UsergridFileMetaDatacFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridFileMetaDatacFT5coderCSo7NSCoder_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:FC11UsergridSDK20UsergridFileMetaData15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK20UsergridFileMetaData15encodeWithCoderFCSo7NSCoderT_">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>