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:36 UTC
[15/51] [partial] usergrid-swift git commit: Initial commit of
Usergrid Swift SDK.
http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/8283a6dd/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html
----------------------------------------------------------------------
diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html b/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html
new file mode 100644
index 0000000..6ff0433
--- /dev/null
+++ b/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html
@@ -0,0 +1,969 @@
+<!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-swift/blob/8283a6dd/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponseError.html
----------------------------------------------------------------------
diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponseError.html b/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponseError.html
new file mode 100644
index 0000000..46fd05a
--- /dev/null
+++ b/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponseError.html
@@ -0,0 +1,473 @@
+<!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>