You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2016/02/16 14:15:05 UTC
[13/75] [partial] usergrid git commit: Initial commit of the Swift
SDK.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/7442c881/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
new file mode 100644
index 0000000..c14fb69
--- /dev/null
+++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes.html
@@ -0,0 +1,573 @@
+<!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> (97% 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/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/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/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/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>
+ </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: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>UsergridClient</code> objects.</p>
+
+<p>The <code>UsergridClientConfig</code> is meant for further customization of <code>UsergridClient</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="Swift">
+ <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></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 base class for <code>UsergridAppAuth</code> and <code>UsergridUserAuth</code> classes.</p>
+
+<p>This class should never be initialized on its own. The use of the <code>UsergridAppAuth</code> and <code>UsergridUserAuth</code> subclasses should be used.</p>
+
+ <a href="Classes/UsergridAuth.html" class="slightly-smaller">See more</a>
+ </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">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>UsergridAuth</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="Swift">
+ <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>UsergridAuth</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="Swift">
+ <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>UsergridEntity</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="Swift">
+ <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></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>UsergridEntity</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="Swift">
+ <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>UsergridClient</code> or <code>Usergrid</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="Swift">
+ <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="Swift">
+ <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></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>UsergridEntity</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="Swift">
+ <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>UsergridClient</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>UsergridClient</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="Swift">
+ <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>UsergridEntity</code> objects and pushed to the <code>entities</code> property.</p>
+
+<p>If a request fails, the <code>errorName</code> and <code>errorDescription</code> 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="Swift">
+ <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>UsergridEntity</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="Swift">
+ <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></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="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>
+ </section>
+ </section>
+ <section id="footer">
+ <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-12-18)</p>
+ <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ 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>