You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by gr...@apache.org on 2016/05/19 17:19:10 UTC
[37/40] usergrid git commit: Fixing documentation.
Fixing documentation.
Project: http://git-wip-us.apache.org/repos/asf/usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/usergrid/commit/ffe8498a
Tree: http://git-wip-us.apache.org/repos/asf/usergrid/tree/ffe8498a
Diff: http://git-wip-us.apache.org/repos/asf/usergrid/diff/ffe8498a
Branch: refs/heads/master
Commit: ffe8498a6dd32bddd0a0f1d61391f233a7f8c522
Parents: e7259b5
Author: Robert Walsh <rj...@gmail.com>
Authored: Thu Apr 14 11:46:18 2016 -0500
Committer: Robert Walsh <rj...@gmail.com>
Committed: Thu Apr 14 11:46:18 2016 -0500
----------------------------------------------------------------------
sdks/swift/Source/Usergrid.swift | 4 +-
sdks/swift/Source/UsergridClient.swift | 6 +-
sdks/swift/Source/UsergridEnums.swift | 10 +-
sdks/swift/docs/Classes/Usergrid.html | 92 ++++++++++++++++++-
sdks/swift/docs/Classes/UsergridAppAuth.html | 2 +-
sdks/swift/docs/Classes/UsergridAuth.html | 2 +-
sdks/swift/docs/Classes/UsergridClient.html | 6 +-
sdks/swift/docs/Classes/UsergridDevice.html | 2 +-
sdks/swift/docs/Classes/UsergridUserAuth.html | 2 +-
sdks/swift/docs/Enums/UsergridAuthMode.html | 12 ++-
sdks/swift/docs/Global Variables.html | 2 +-
.../Resources/Documents/Classes/Usergrid.html | 92 ++++++++++++++++++-
.../Documents/Classes/UsergridAppAuth.html | 2 +-
.../Documents/Classes/UsergridAuth.html | 2 +-
.../Documents/Classes/UsergridClient.html | 6 +-
.../Documents/Classes/UsergridDevice.html | 2 +-
.../Documents/Classes/UsergridUserAuth.html | 2 +-
.../Documents/Enums/UsergridAuthMode.html | 12 ++-
.../Resources/Documents/Global Variables.html | 2 +-
.../.docset/Contents/Resources/docSet.dsidx | Bin 147456 -> 147456 bytes
sdks/swift/docs/docsets/.tgz | Bin 148119 -> 148251 bytes
21 files changed, 219 insertions(+), 41 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/Source/Usergrid.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/Usergrid.swift b/sdks/swift/Source/Usergrid.swift
index a6f595b..063d361 100644
--- a/sdks/swift/Source/Usergrid.swift
+++ b/sdks/swift/Source/Usergrid.swift
@@ -87,7 +87,7 @@ public class Usergrid: NSObject {
set(auth) { Usergrid.sharedInstance.appAuth = auth }
}
- /// The `UsergridAuthFallback` value used to determine what type of token will be sent of the shared instance of `UsergridClient`, if any.
+ /// The `UsergridAuthMode` value used to determine what type of token will be sent of the shared instance of `UsergridClient`, if any.
public static var authMode: UsergridAuthMode {
get { return Usergrid.sharedInstance.authMode }
set(mode) { Usergrid.sharedInstance.authMode = mode }
@@ -206,7 +206,7 @@ public class Usergrid: NSObject {
If there is a `UsergridUser` logged in and the token of that user is valid then it will return that.
- Otherwise, if the `authFallback` is `.App`, and the `UsergridAppAuth` of the client is set and the token is valid it will return that.
+ Otherwise, if the `authMode` is `.App`, and the `UsergridAppAuth` of the client is set and the token is valid it will return that.
- returns: The `UsergridAuth` if one is found or nil if not.
*/
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/Source/UsergridClient.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridClient.swift b/sdks/swift/Source/UsergridClient.swift
index ba4ba7d..2b3eb6b 100644
--- a/sdks/swift/Source/UsergridClient.swift
+++ b/sdks/swift/Source/UsergridClient.swift
@@ -78,13 +78,13 @@ public class UsergridClient: NSObject, NSCoding {
/// The temporary `UsergridAuth` object that is set when calling the `UsergridClient.usingAuth()` method.
private var tempAuth: UsergridAuth? = nil
- /// The application level `UsergridAppAuth` object. Can be set manually but must call `authenticateApp` to retrive token.
+ /// The application level `UsergridAppAuth` object. Can be set manually but must call `authenticateApp` to retrieve token.
public var appAuth: UsergridAppAuth? {
get { return config.appAuth }
set(auth) { config.appAuth = auth }
}
- /// The `UsergridAuthFallback` value used to determine what type of token will be sent, if any.
+ /// The `UsergridAuthMode` value used to determine what type of token will be sent, if any.
public var authMode: UsergridAuthMode {
get { return config.authMode }
set(mode) { config.authMode = mode }
@@ -213,7 +213,7 @@ public class UsergridClient: NSObject, NSCoding {
If there is a `UsergridUser` logged in and the token of that user is valid then it will return that.
- Otherwise, if the `authFallback` is `.App`, and the `UsergridAppAuth` of the client is set and the token is valid it will return that.
+ Otherwise, if the `authMode` is `.App`, and the `UsergridAppAuth` of the client is set and the token is valid it will return that.
- returns: The `UsergridAuth` if one is found or nil if not.
*/
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/Source/UsergridEnums.swift
----------------------------------------------------------------------
diff --git a/sdks/swift/Source/UsergridEnums.swift b/sdks/swift/Source/UsergridEnums.swift
index a2468af..fd0b625 100644
--- a/sdks/swift/Source/UsergridEnums.swift
+++ b/sdks/swift/Source/UsergridEnums.swift
@@ -34,19 +34,21 @@ An enumeration that is used to determine what the `UsergridClient` will use for
// MARK: - Values -
/**
- If a non-expired user auth token exists in `UsergridClient.currentUser`, this token is used to authenticate all API calls.
-
If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.
*/
case None
/**
- If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authFallback=.None).
+ If a non-expired `UsergridUserAuth` exists in `UsergridClient.currentUser`, this token is used to authenticate all API calls.
+
+ If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).
*/
case User
/**
- If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authFallback=.None).
+ If a non-expired `UsergridAppAuth` exists in `UsergridClient.appAuth`, this token is used to authenticate all API calls.
+
+ If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).
*/
case App
}
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/Classes/Usergrid.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/Usergrid.html b/sdks/swift/docs/Classes/Usergrid.html
index 73da052..61bf26f 100644
--- a/sdks/swift/docs/Classes/Usergrid.html
+++ b/sdks/swift/docs/Classes/Usergrid.html
@@ -477,7 +477,7 @@ within the UsergridSDK library.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>The <code>UsergridAuthFallback</code> value used to determine what type of token will be sent of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, if any.</p>
+ <p>The <code><a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, if any.</p>
</div>
<div class="declaration">
@@ -1003,7 +1003,7 @@ within the UsergridSDK library.</p>
<p>If there is a <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> logged in and the token of that user is valid then it will return that.</p>
-<p>Otherwise, if the <code>authFallback</code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</p>
+<p>Otherwise, if the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid8authModeOS_16UsergridAuthMode">authMode</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</p>
</div>
<div class="declaration">
@@ -1265,6 +1265,92 @@ within the UsergridSDK library.</p>
<li class="item">
<div>
<code>
+ <a name="/s:ZFC11UsergridSDK8Usergrid13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a>
+ <a name="//apple_ref/swift/Method/resetPassword(_:old:new:completion:)" class="dashAnchor"></a>
+ <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:old:new:completion:)</a>
+ </code>
+ </div>
+ <div class="height-container">
+ <div class="pointer-container"></div>
+ <section class="section">
+ <div class="pointer"></div>
+ <div class="abstract">
+ <p>Changes the given <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
+
+ </div>
+ <div class="declaration">
+ <h4>Declaration</h4>
+ <div class="language">
+ <p class="aside-title">Swift</p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">resetPassword</span><span class="p">(</span><span class="nv">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">,</span> <span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserResetPasswordCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
+
+ </div>
+ </div>
+ <div>
+ <h4>Parameters</h4>
+ <table class="graybox">
+ <tbody>
+ <tr>
+ <td>
+ <code>
+ <em>user</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The user.</p>
+
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ <em>old</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The old password.</p>
+
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ <em>new</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The new password.</p>
+
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ <em>completion</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The optional completion block.</p>
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </section>
+ </div>
+ </li>
+ <li class="item">
+ <div>
+ <code>
<a name="/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_">logoutCurrentUser(_:)</a>
@@ -1275,7 +1361,7 @@ within the UsergridSDK library.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>Logs out the current user of the shared instance locally and remotely.</p>
+ <p>Logs out the current user of the shared instance locally and remotely using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
</div>
<div class="declaration">
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/Classes/UsergridAppAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridAppAuth.html b/sdks/swift/docs/Classes/UsergridAppAuth.html
index c872daf..70c940e 100644
--- a/sdks/swift/docs/Classes/UsergridAppAuth.html
+++ b/sdks/swift/docs/Classes/UsergridAppAuth.html
@@ -342,7 +342,7 @@
</div>
<div>
<h4>Return Value</h4>
- <p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
+ <p>A decoded <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object.</p>
</div>
</section>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/Classes/UsergridAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridAuth.html b/sdks/swift/docs/Classes/UsergridAuth.html
index 69ea296..8d1f6fd 100644
--- a/sdks/swift/docs/Classes/UsergridAuth.html
+++ b/sdks/swift/docs/Classes/UsergridAuth.html
@@ -452,7 +452,7 @@
</div>
<div>
<h4>Return Value</h4>
- <p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
+ <p>A decoded <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object.</p>
</div>
</section>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/Classes/UsergridClient.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridClient.html b/sdks/swift/docs/Classes/UsergridClient.html
index 1573e0d..09c2175 100644
--- a/sdks/swift/docs/Classes/UsergridClient.html
+++ b/sdks/swift/docs/Classes/UsergridClient.html
@@ -438,7 +438,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>The <code>UsergridAuthFallback</code> value used to determine what type of token will be sent, if any.</p>
+ <p>The <code><a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent, if any.</p>
</div>
<div class="declaration">
@@ -968,7 +968,7 @@
<p>If there is a <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> logged in and the token of that user is valid then it will return that.</p>
-<p>Otherwise, if the <code>authFallback</code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</p>
+<p>Otherwise, if the <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode">authMode</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</p>
</div>
<div class="declaration">
@@ -1348,7 +1348,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>Changes the give <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
+ <p>Changes the given <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password.</p>
</div>
<div class="declaration">
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/Classes/UsergridDevice.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridDevice.html b/sdks/swift/docs/Classes/UsergridDevice.html
index b0742e2..9cda8aa 100644
--- a/sdks/swift/docs/Classes/UsergridDevice.html
+++ b/sdks/swift/docs/Classes/UsergridDevice.html
@@ -638,7 +638,7 @@ let uuid = usergridDevice["uuid"]
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">save</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">save</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/Classes/UsergridUserAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Classes/UsergridUserAuth.html b/sdks/swift/docs/Classes/UsergridUserAuth.html
index 242a0dd..15b46fb 100644
--- a/sdks/swift/docs/Classes/UsergridUserAuth.html
+++ b/sdks/swift/docs/Classes/UsergridUserAuth.html
@@ -342,7 +342,7 @@
</div>
<div>
<h4>Return Value</h4>
- <p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
+ <p>A decoded <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> object.</p>
</div>
</section>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/Enums/UsergridAuthMode.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Enums/UsergridAuthMode.html b/sdks/swift/docs/Enums/UsergridAuthMode.html
index 4aa4e0a..7ed672a 100644
--- a/sdks/swift/docs/Enums/UsergridAuthMode.html
+++ b/sdks/swift/docs/Enums/UsergridAuthMode.html
@@ -188,9 +188,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>If a non-expired user auth token exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p>
-
-<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.</p>
+ <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.</p>
</div>
<div class="declaration">
@@ -221,7 +219,9 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authFallback=.None).</p>
+ <p>If a non-expired <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p>
+
+<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).</p>
</div>
<div class="declaration">
@@ -252,7 +252,9 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authFallback=.None).</p>
+ <p>If a non-expired <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_">UsergridClient.appAuth</a></code>, this token is used to authenticate all API calls.</p>
+
+<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).</p>
</div>
<div class="declaration">
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/Global Variables.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/Global Variables.html b/sdks/swift/docs/Global Variables.html
index a02b60f..2685313 100644
--- a/sdks/swift/docs/Global Variables.html
+++ b/sdks/swift/docs/Global Variables.html
@@ -188,7 +188,7 @@
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">UsergridSDKVersion</span> <span class="o">=</span> <span class="s">"2.1.0"</span></code></pre>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">UsergridSDKVersion</span> <span class="o">=</span> <span class="s">"2.1.1"</span></code></pre>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html
index 73da052..61bf26f 100644
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html
+++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html
@@ -477,7 +477,7 @@ within the UsergridSDK library.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>The <code>UsergridAuthFallback</code> value used to determine what type of token will be sent of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, if any.</p>
+ <p>The <code><a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, if any.</p>
</div>
<div class="declaration">
@@ -1003,7 +1003,7 @@ within the UsergridSDK library.</p>
<p>If there is a <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> logged in and the token of that user is valid then it will return that.</p>
-<p>Otherwise, if the <code>authFallback</code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</p>
+<p>Otherwise, if the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid8authModeOS_16UsergridAuthMode">authMode</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</p>
</div>
<div class="declaration">
@@ -1265,6 +1265,92 @@ within the UsergridSDK library.</p>
<li class="item">
<div>
<code>
+ <a name="/s:ZFC11UsergridSDK8Usergrid13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a>
+ <a name="//apple_ref/swift/Method/resetPassword(_:old:new:completion:)" class="dashAnchor"></a>
+ <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:old:new:completion:)</a>
+ </code>
+ </div>
+ <div class="height-container">
+ <div class="pointer-container"></div>
+ <section class="section">
+ <div class="pointer"></div>
+ <div class="abstract">
+ <p>Changes the given <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
+
+ </div>
+ <div class="declaration">
+ <h4>Declaration</h4>
+ <div class="language">
+ <p class="aside-title">Swift</p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">resetPassword</span><span class="p">(</span><span class="nv">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">,</span> <span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserResetPasswordCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
+
+ </div>
+ </div>
+ <div>
+ <h4>Parameters</h4>
+ <table class="graybox">
+ <tbody>
+ <tr>
+ <td>
+ <code>
+ <em>user</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The user.</p>
+
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ <em>old</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The old password.</p>
+
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ <em>new</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The new password.</p>
+
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ <em>completion</em>
+ </code>
+ </td>
+ <td>
+ <div>
+ <p>The optional completion block.</p>
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </section>
+ </div>
+ </li>
+ <li class="item">
+ <div>
+ <code>
<a name="/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_">logoutCurrentUser(_:)</a>
@@ -1275,7 +1361,7 @@ within the UsergridSDK library.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>Logs out the current user of the shared instance locally and remotely.</p>
+ <p>Logs out the current user of the shared instance locally and remotely using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
</div>
<div class="declaration">
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html
index c872daf..70c940e 100644
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html
+++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html
@@ -342,7 +342,7 @@
</div>
<div>
<h4>Return Value</h4>
- <p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
+ <p>A decoded <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object.</p>
</div>
</section>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
index 69ea296..8d1f6fd 100644
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
+++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
@@ -452,7 +452,7 @@
</div>
<div>
<h4>Return Value</h4>
- <p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
+ <p>A decoded <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object.</p>
</div>
</section>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClient.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClient.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClient.html
index 1573e0d..09c2175 100644
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClient.html
+++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridClient.html
@@ -438,7 +438,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>The <code>UsergridAuthFallback</code> value used to determine what type of token will be sent, if any.</p>
+ <p>The <code><a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent, if any.</p>
</div>
<div class="declaration">
@@ -968,7 +968,7 @@
<p>If there is a <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> logged in and the token of that user is valid then it will return that.</p>
-<p>Otherwise, if the <code>authFallback</code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</p>
+<p>Otherwise, if the <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode">authMode</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</p>
</div>
<div class="declaration">
@@ -1348,7 +1348,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>Changes the give <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p>
+ <p>Changes the given <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password.</p>
</div>
<div class="declaration">
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridDevice.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridDevice.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridDevice.html
index b0742e2..9cda8aa 100644
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridDevice.html
+++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridDevice.html
@@ -638,7 +638,7 @@ let uuid = usergridDevice["uuid"]
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">save</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">save</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html
index 242a0dd..15b46fb 100644
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html
+++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html
@@ -342,7 +342,7 @@
</div>
<div>
<h4>Return Value</h4>
- <p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
+ <p>A decoded <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> object.</p>
</div>
</section>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html
index 4aa4e0a..7ed672a 100644
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html
+++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html
@@ -188,9 +188,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>If a non-expired user auth token exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p>
-
-<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.</p>
+ <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.</p>
</div>
<div class="declaration">
@@ -221,7 +219,9 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authFallback=.None).</p>
+ <p>If a non-expired <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p>
+
+<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).</p>
</div>
<div class="declaration">
@@ -252,7 +252,9 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
- <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authFallback=.None).</p>
+ <p>If a non-expired <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_">UsergridClient.appAuth</a></code>, this token is used to authenticate all API calls.</p>
+
+<p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).</p>
</div>
<div class="declaration">
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Global Variables.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Global Variables.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Global Variables.html
index a02b60f..2685313 100644
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Global Variables.html
+++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Global Variables.html
@@ -188,7 +188,7 @@
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">UsergridSDKVersion</span> <span class="o">=</span> <span class="s">"2.1.0"</span></code></pre>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">UsergridSDKVersion</span> <span class="o">=</span> <span class="s">"2.1.1"</span></code></pre>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/docsets/.docset/Contents/Resources/docSet.dsidx
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/docSet.dsidx b/sdks/swift/docs/docsets/.docset/Contents/Resources/docSet.dsidx
index 728409f..15754e6 100644
Binary files a/sdks/swift/docs/docsets/.docset/Contents/Resources/docSet.dsidx and b/sdks/swift/docs/docsets/.docset/Contents/Resources/docSet.dsidx differ
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ffe8498a/sdks/swift/docs/docsets/.tgz
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.tgz b/sdks/swift/docs/docsets/.tgz
index 562ef58..453a706 100644
Binary files a/sdks/swift/docs/docsets/.tgz and b/sdks/swift/docs/docsets/.tgz differ