http://git-wip-us.apache.org/repos/asf/usergrid/blob/c733f01f/sdks/swift/docs/Typealiases.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Typealiases.html b/sdks/swift/docs/Typealiases.html index ce55836..4a5b04a 100644 --- a/sdks/swift/docs/Typealiases.html +++ b/sdks/swift/docs/Typealiases.html @@ -13,12 +13,12 @@ <a title="Typealiases Reference"></a> <header> <div class="content-wrapper"> - <p><a href="index.html">UsergridSDK Docs</a> (100% documented)</p> + <p><a href="index.html"> Docs</a> (100% documented)</p> </div> </header> <div class="content-wrapper"> <p id="breadcrumbs"> - <a href="index.html">UsergridSDK Reference</a> + <a href="index.html"> Reference</a> <img id="carat" src="img/carat.png" /> Typealiases Reference </p> @@ -91,7 +91,7 @@ <a href="Enums.html">Enums</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> - <a href="Enums/UsergridAuthFallback.html">UsergridAuthFallback</a> + <a href="Enums/UsergridAuthMode.html">UsergridAuthMode</a> </li> <li class="nav-group-task"> <a href="Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a> @@ -120,6 +120,14 @@ </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"> @@ -337,9 +345,9 @@ <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> + <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"> @@ -347,14 +355,14 @@ <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> + <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">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">String</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> + <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> @@ -364,9 +372,9 @@ <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> + <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"> @@ -374,14 +382,14 @@ <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> + <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">UsergridAssetUploadCompletion</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="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">String</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> + <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> @@ -393,7 +401,7 @@ </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>© 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 âªâ« v0.5.0</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> </section> </article>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/c733f01f/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 index c14fb69..c6b6e22 100644 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -7,12 +7,13 @@ <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> + <p><a href="index.html"> Docs</a> (100% documented)</p> </div> </header> <div class="content-wrapper"> @@ -26,7 +27,7 @@ <nav class="sidebar"> <ul class="nav-groups"> <li class="nav-group-name"> - <a href="Classes.html">Classes</a> + <a href="Classes.html">Classes</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Classes/Usergrid.html">Usergrid</a> @@ -38,6 +39,9 @@ <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"> @@ -59,9 +63,15 @@ <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"> @@ -70,10 +80,18 @@ </ul> </li> <li class="nav-group-name"> - <a href="Enums.html">Enums</a> + <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> + <a href="Enums/UsergridAuthMode.html">UsergridAuthMode</a> </li> <li class="nav-group-task"> <a href="Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a> @@ -85,6 +103,9 @@ <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"> @@ -99,7 +120,15 @@ </ul> </li> <li class="nav-group-name"> - <a href="Typealiases.html">Typealiases</a> + <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> @@ -119,6 +148,12 @@ <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> @@ -136,6 +171,100 @@ <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> @@ -146,17 +275,17 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p><code>UsergridClientConfig</code> is used when initializing <code>UsergridClient</code> objects.</p> + <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>UsergridClient</code> objects when needed.</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="Swift"> + <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></code></pre> + <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> @@ -180,15 +309,15 @@ <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>The <code>UsergridAuth</code> class functions to create and store authentication information used by Usergrid.</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> +<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="Swift"> + <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> @@ -210,13 +339,13 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>The <code>UsergridAuth</code> subclass used for user level authorization.</p> + <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="Swift"> + <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> @@ -238,13 +367,13 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>The <code>UsergridAuth</code> subclass used for application level authorization.</p> + <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="Swift"> + <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> @@ -270,15 +399,15 @@ <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> + <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="Swift"> + <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></code></pre> + <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> @@ -302,7 +431,7 @@ <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><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> @@ -310,7 +439,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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> @@ -338,13 +467,13 @@ <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> +<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="Swift"> + <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> @@ -378,9 +507,9 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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></code></pre> + <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> @@ -404,13 +533,13 @@ <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> + <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="Swift"> + <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> @@ -436,18 +565,18 @@ <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 <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>UsergridClient</code> object. Because of this, before using any of the static methods +<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="Swift"> + <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> @@ -475,15 +604,15 @@ provided you will need to call one of the shared instance initialization methods <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 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>errorName</code> and <code>errorDescription</code> will contain information about the problem encountered.</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="Swift"> + <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> @@ -509,7 +638,7 @@ provided you will need to call one of the shared instance initialization methods <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>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> @@ -517,9 +646,9 @@ provided you will need to call one of the shared instance initialization methods </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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></code></pre> + <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> @@ -549,9 +678,9 @@ provided you will need to call one of the shared instance initialization methods </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <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></code></pre> + <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> @@ -563,8 +692,8 @@ provided you will need to call one of the shared instance initialization methods </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> + <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 âªâ« v0.5.0</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> </section> </article> </div>
