http://git-wip-us.apache.org/repos/asf/usergrid/blob/c638c774/sdks/swift/docs/Classes/UsergridQuery.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Classes/UsergridQuery.html b/sdks/swift/docs/Classes/UsergridQuery.html index aadef06..a5db6e2 100644 --- a/sdks/swift/docs/Classes/UsergridQuery.html +++ b/sdks/swift/docs/Classes/UsergridQuery.html @@ -368,6 +368,71 @@ <li class="item"> <div> <code> + <a name="/s:FC11UsergridSDK13UsergridQuery8containsFS0_FTSS5valueSS_DS0_"></a> + <a name="//apple_ref/swift/Method/contains(_:value:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery8containsFS0_FTSS5valueSS_DS0_">contains(_:value:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Contains. Query: where term contains ‘val%’.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">contains</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">containsWord</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="n">value</span><span class="p">)</span> <span class="p">}</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>term</em> + </code> + </td> + <td> + <div> + <p>The term.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>value</em> + </code> + </td> + <td> + <div> + <p>The value.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p><code>Self</code></p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> <a name="/s:FC11UsergridSDK13UsergridQuery14containsStringFS0_FTSS5valueSS_DS0_"></a> <a name="//apple_ref/swift/Method/containsString(_:value:)" class="dashAnchor"></a> <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery14containsStringFS0_FTSS5valueSS_DS0_">containsString(_:value:)</a> @@ -567,7 +632,7 @@ <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">asc</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">sort</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">sortOrder</span><span class="p">:</span> <span class="kt">UsergridQuerySortOrder</span><span class="o">.</span><span class="kt">Asc</span><span class="p">)</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">asc</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">sort</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">sortOrder</span><span class="p">:</span> <span class="o">.</span><span class="kt">Asc</span><span class="p">)</span> <span class="p">}</span></code></pre> </div> </div> @@ -671,7 +736,7 @@ <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">desc</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">sort</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">sortOrder</span><span class="p">:</span> <span class="kt">UsergridQuerySortOrder</span><span class="o">.</span><span class="kt">Desc</span><span class="p">)</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">desc</span><span class="p">(</span><span class="nv">term</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="nf">sort</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="nv">sortOrder</span><span class="p">:</span> <span class="o">.</span><span class="kt">Desc</span><span class="p">)</span> <span class="p">}</span></code></pre> </div> </div> @@ -1509,7 +1574,7 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Joining operation to combine conditional queries.</p> + <p>Or operation for conditional queries.</p> </div> <div class="declaration"> @@ -1531,6 +1596,38 @@ <li class="item"> <div> <code> + <a name="/s:FC11UsergridSDK13UsergridQuery3andFS0_FT_DS0_"></a> + <a name="//apple_ref/swift/Method/and()" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3andFS0_FT_DS0_">and()</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>And operation for conditional queries.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">and</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre> + + </div> + </div> + <div> + <h4>Return Value</h4> + <p><code>Self</code></p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> <a name="/s:FC11UsergridSDK13UsergridQuery3notFS0_FT_DS0_"></a> <a name="//apple_ref/swift/Method/not()" class="dashAnchor"></a> <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery3notFS0_FT_DS0_">not()</a> @@ -1680,6 +1777,58 @@ <li class="item"> <div> <code> + <a name="/s:FC11UsergridSDK13UsergridQuery4typeFS0_FSSDS0_"></a> + <a name="//apple_ref/swift/Method/type(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery4typeFS0_FSSDS0_">type(_:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Sets the collection name.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">type</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>type</em> + </code> + </td> + <td> + <div> + <p>The new collection name.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p><code>Self</code></p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> <a name="/s:FC11UsergridSDK13UsergridQuery5limitFS0_FSiDS0_"></a> <a name="//apple_ref/swift/Method/limit(_:)" class="dashAnchor"></a> <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery5limitFS0_FSiDS0_">limit(_:)</a> @@ -1836,6 +1985,58 @@ <li class="item"> <div> <code> + <a name="/s:FC11UsergridSDK13UsergridQuery10fromStringFS0_FGSqSS_DS0_"></a> + <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery10fromStringFS0_FGSqSS_DS0_">fromString(_:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>A special builder property that allows you to input a pre-defined query string. All builder properties will be ignored when this property is defined.</p> + + </div> + <div class="declaration"> + <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">fromString</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>value</em> + </code> + </td> + <td> + <div> + <p>The pre-defined query string.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p><code>Self</code></p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> <a name="/s:FC11UsergridSDK13UsergridQuery7urlTermFS0_FTSS11equalsValueSS_DS0_"></a> <a name="//apple_ref/swift/Method/urlTerm(_:equalsValue:)" class="dashAnchor"></a> <a class="token" href="#/s:FC11UsergridSDK13UsergridQuery7urlTermFS0_FTSS11equalsValueSS_DS0_">urlTerm(_:equalsValue:)</a> @@ -2059,7 +2260,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Classes/UsergridRequest.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Classes/UsergridRequest.html b/sdks/swift/docs/Classes/UsergridRequest.html index b38129b..868cb77 100644 --- a/sdks/swift/docs/Classes/UsergridRequest.html +++ b/sdks/swift/docs/Classes/UsergridRequest.html @@ -601,7 +601,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Classes/UsergridResponse.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Classes/UsergridResponse.html b/sdks/swift/docs/Classes/UsergridResponse.html index 0d8b6fe..d945c75 100644 --- a/sdks/swift/docs/Classes/UsergridResponse.html +++ b/sdks/swift/docs/Classes/UsergridResponse.html @@ -165,7 +165,7 @@ <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> </section> <section class="section task-group-section"> @@ -951,7 +951,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Classes/UsergridResponseError.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Classes/UsergridResponseError.html b/sdks/swift/docs/Classes/UsergridResponseError.html index 7e8b749..99b74fe 100644 --- a/sdks/swift/docs/Classes/UsergridResponseError.html +++ b/sdks/swift/docs/Classes/UsergridResponseError.html @@ -455,7 +455,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Classes/UsergridUser.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Classes/UsergridUser.html b/sdks/swift/docs/Classes/UsergridUser.html index 57317cc..25d3739 100644 --- a/sdks/swift/docs/Classes/UsergridUser.html +++ b/sdks/swift/docs/Classes/UsergridUser.html @@ -2038,12 +2038,278 @@ let someName = usergridUser[<q>name</q>]</p></li></p> </section> </div> </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK12UsergridUser15connectToDeviceFS0_FTGSqCS_14UsergridDevice_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> + <a name="//apple_ref/swift/Method/connectToDevice(_:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUser15connectToDeviceFS0_FTGSqCS_14UsergridDevice_10completionGSqFT8responseCS_16UsergridResponse_T___T_">connectToDevice(_:completion:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>A special convenience function that connects a <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> to this <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">connectToDevice</span><span class="p">(</span><span class="nv">device</span><span class="p">:</span><span class="kt">UsergridDevice</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>device</em> + </code> + </td> + <td> + <div> + <p>The device to connect to. If nil it will use the <code>UsergridDevice.sharedDevice</code> instance.</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:FC11UsergridSDK12UsergridUser15connectToDeviceFS0_FTCS_14UsergridClient6deviceGSqCS_14UsergridDevice_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> + <a name="//apple_ref/swift/Method/connectToDevice(_:device:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUser15connectToDeviceFS0_FTCS_14UsergridClient6deviceGSqCS_14UsergridDevice_10completionGSqFT8responseCS_16UsergridResponse_T___T_">connectToDevice(_:device:completion:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>A special convenience function that connects a <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> to this <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">connectToDevice</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">device</span><span class="p">:</span><span class="kt">UsergridDevice</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <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 <code>UsergridClient</code> object to use for connecting.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>device</em> + </code> + </td> + <td> + <div> + <p>The device to connect to. If nil it will use the <code>UsergridDevice.sharedDevice</code> instance.</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:FC11UsergridSDK12UsergridUser20disconnectFromDeviceFS0_FTGSqCS_14UsergridDevice_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> + <a name="//apple_ref/swift/Method/disconnectFromDevice(_:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUser20disconnectFromDeviceFS0_FTGSqCS_14UsergridDevice_10completionGSqFT8responseCS_16UsergridResponse_T___T_">disconnectFromDevice(_:completion:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>A special convenience function that disconnects a <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> from this <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">disconnectFromDevice</span><span class="p">(</span><span class="nv">device</span><span class="p">:</span><span class="kt">UsergridDevice</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>device</em> + </code> + </td> + <td> + <div> + <p>The device to connect to. If nil it will use the <code>UsergridDevice.sharedDevice</code> instance.</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:FC11UsergridSDK12UsergridUser20disconnectFromDeviceFS0_FTCS_14UsergridClient6deviceGSqCS_14UsergridDevice_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> + <a name="//apple_ref/swift/Method/disconnectFromDevice(_:device:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUser20disconnectFromDeviceFS0_FTCS_14UsergridClient6deviceGSqCS_14UsergridDevice_10completionGSqFT8responseCS_16UsergridResponse_T___T_">disconnectFromDevice(_:device:completion:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>A special convenience function that disconnects a <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> from this <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">disconnectFromDevice</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">device</span><span class="p">:</span><span class="kt">UsergridDevice</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <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 <code>UsergridClient</code> object to use for connecting.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>device</em> + </code> + </td> + <td> + <div> + <p>The device to connect to.</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> </ul> </div> </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Classes/UsergridUserAuth.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Classes/UsergridUserAuth.html b/sdks/swift/docs/Classes/UsergridUserAuth.html index 368b1a4..7818929 100644 --- a/sdks/swift/docs/Classes/UsergridUserAuth.html +++ b/sdks/swift/docs/Classes/UsergridUserAuth.html @@ -392,7 +392,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Enums.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Enums.html b/sdks/swift/docs/Enums.html index 47fdade..d5f70b5 100644 --- a/sdks/swift/docs/Enums.html +++ b/sdks/swift/docs/Enums.html @@ -417,7 +417,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Enums/UsergridAuthFallback.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Enums/UsergridAuthFallback.html b/sdks/swift/docs/Enums/UsergridAuthFallback.html index 362bcfd..13d19bc 100644 --- a/sdks/swift/docs/Enums/UsergridAuthFallback.html +++ b/sdks/swift/docs/Enums/UsergridAuthFallback.html @@ -238,7 +238,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Enums/UsergridDeviceProperties.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Enums/UsergridDeviceProperties.html b/sdks/swift/docs/Enums/UsergridDeviceProperties.html index ca2ffb9..da53073 100644 --- a/sdks/swift/docs/Enums/UsergridDeviceProperties.html +++ b/sdks/swift/docs/Enums/UsergridDeviceProperties.html @@ -351,7 +351,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Enums/UsergridDirection.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Enums/UsergridDirection.html b/sdks/swift/docs/Enums/UsergridDirection.html index 29e1390..8289bcb 100644 --- a/sdks/swift/docs/Enums/UsergridDirection.html +++ b/sdks/swift/docs/Enums/UsergridDirection.html @@ -268,7 +268,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Enums/UsergridEntityProperties.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Enums/UsergridEntityProperties.html b/sdks/swift/docs/Enums/UsergridEntityProperties.html index 07ec119..809b5b1 100644 --- a/sdks/swift/docs/Enums/UsergridEntityProperties.html +++ b/sdks/swift/docs/Enums/UsergridEntityProperties.html @@ -496,7 +496,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Enums/UsergridHttpMethod.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Enums/UsergridHttpMethod.html b/sdks/swift/docs/Enums/UsergridHttpMethod.html index 30ab914..65718cd 100644 --- a/sdks/swift/docs/Enums/UsergridHttpMethod.html +++ b/sdks/swift/docs/Enums/UsergridHttpMethod.html @@ -323,7 +323,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Enums/UsergridImageContentType.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Enums/UsergridImageContentType.html b/sdks/swift/docs/Enums/UsergridImageContentType.html index a9051ed..850b843 100644 --- a/sdks/swift/docs/Enums/UsergridImageContentType.html +++ b/sdks/swift/docs/Enums/UsergridImageContentType.html @@ -268,7 +268,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Enums/UsergridQueryOperator.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Enums/UsergridQueryOperator.html b/sdks/swift/docs/Enums/UsergridQueryOperator.html index fcf3109..1a7c201 100644 --- a/sdks/swift/docs/Enums/UsergridQueryOperator.html +++ b/sdks/swift/docs/Enums/UsergridQueryOperator.html @@ -413,7 +413,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Enums/UsergridQuerySortOrder.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Enums/UsergridQuerySortOrder.html b/sdks/swift/docs/Enums/UsergridQuerySortOrder.html index 0aefe8f..a79f9c6 100644 --- a/sdks/swift/docs/Enums/UsergridQuerySortOrder.html +++ b/sdks/swift/docs/Enums/UsergridQuerySortOrder.html @@ -320,7 +320,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Enums/UsergridUserProperties.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Enums/UsergridUserProperties.html b/sdks/swift/docs/Enums/UsergridUserProperties.html index 34b0b8a..140d2e5 100644 --- a/sdks/swift/docs/Enums/UsergridUserProperties.html +++ b/sdks/swift/docs/Enums/UsergridUserProperties.html @@ -506,7 +506,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Global Variables.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Global Variables.html b/sdks/swift/docs/Global Variables.html index 47d0704..3b39019 100644 --- a/sdks/swift/docs/Global Variables.html +++ b/sdks/swift/docs/Global Variables.html @@ -192,7 +192,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/Typealiases.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Typealiases.html b/sdks/swift/docs/Typealiases.html index ff3fb7b..ce55836 100644 --- a/sdks/swift/docs/Typealiases.html +++ b/sdks/swift/docs/Typealiases.html @@ -393,7 +393,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes.html index 0e1af9e..c867dcf 100644 --- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes.html +++ b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes.html @@ -598,7 +598,7 @@ provided you will need to call one of the shared instance initialization methods <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> @@ -684,7 +684,7 @@ provided you will need to call one of the shared instance initialization methods </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/Usergrid.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/Usergrid.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/Usergrid.html index d2d75d9..d959029 100644 --- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/Usergrid.html +++ b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/Usergrid.html @@ -378,6 +378,33 @@ within the UsergridSDK library.</p> <li class="item"> <div> <code> + <a name="/s:ZvC11UsergridSDK8Usergrid28persistCurrentUserInKeychainSb"></a> + <a name="//apple_ref/swift/Variable/persistCurrentUserInKeychain" class="dashAnchor"></a> + <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Whether or not the current user will be saved and restored from the keychain using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> <a name="/s:ZvC11UsergridSDK8Usergrid8userAuthGSqCS_16UsergridUserAuth_"></a> <a name="//apple_ref/swift/Variable/userAuth" class="dashAnchor"></a> <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid8userAuthGSqCS_16UsergridUserAuth_">userAuth</a> @@ -429,6 +456,33 @@ within the UsergridSDK library.</p> </section> </div> </li> + <li class="item"> + <div> + <code> + <a name="/s:ZvC11UsergridSDK8Usergrid12authFallbackOS_20UsergridAuthFallback"></a> + <a name="//apple_ref/swift/Variable/authFallback" class="dashAnchor"></a> + <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid12authFallbackOS_20UsergridAuthFallback">authFallback</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The <code><a href="../Enums/UsergridAuthFallback.html">UsergridAuthFallback</a></code> value used to determine what type of token will be sent of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, if any.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">authFallback</span><span class="p">:</span> <span class="kt">UsergridAuthFallback</span></code></pre> + + </div> + </div> + </section> + </div> + </li> </ul> </div> <div class="task-group"> @@ -819,33 +873,6 @@ within the UsergridSDK library.</p> <li class="item"> <div> <code> - <a name="/s:ZvC11UsergridSDK8Usergrid12authFallbackOS_20UsergridAuthFallback"></a> - <a name="//apple_ref/swift/Variable/authFallback" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid12authFallbackOS_20UsergridAuthFallback">authFallback</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The <code><a href="../Enums/UsergridAuthFallback.html">UsergridAuthFallback</a></code> value used to determine what type of token will be sent of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, if any.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">authFallback</span><span class="p">:</span> <span class="kt">UsergridAuthFallback</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> <a name="/s:ZFC11UsergridSDK8Usergrid9usingAuthFMS0_FCS_12UsergridAuthCS_14UsergridClient"></a> <a name="//apple_ref/swift/Method/usingAuth(_:)" class="dashAnchor"></a> <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid9usingAuthFMS0_FCS_12UsergridAuthCS_14UsergridClient">usingAuth(_:)</a> @@ -1534,9 +1561,9 @@ within the UsergridSDK library.</p> <li class="item"> <div> <code> - <a name="/s:ZFC11UsergridSDK8Usergrid3GETFMS0_FTSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/GET(_:query:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid3GETFMS0_FTSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:query:completion:)</a> + <a name="/s:ZFC11UsergridSDK8Usergrid3GETFMS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> + <a name="//apple_ref/swift/Method/GET(_:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid3GETFMS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:completion:)</a> </code> </div> <div class="height-container"> @@ -1544,14 +1571,14 @@ within the UsergridSDK library.</p> <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Gets a group of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects of a given type with an optional query using the shared instance of <code>UsergridCient</code>.</p> + <p>Gets a group of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects of a given type using the shared instance of <code>UsergridCient</code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> </div> </div> @@ -1575,12 +1602,59 @@ within the UsergridSDK library.</p> <tr> <td> <code> + <em>completion</em> + </code> + </td> + <td> + <div> + <p>The optional completion block that will be called once the request has completed.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:ZFC11UsergridSDK8Usergrid3GETFMS0_FTCS_13UsergridQuery15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_"></a> + <a name="//apple_ref/swift/Method/GET(_:queryCompletion:)" class="dashAnchor"></a> + <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid3GETFMS0_FTCS_13UsergridQuery15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:queryCompletion:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Gets a group of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects with a given query using the shared instance of <code>UsergridCient</code>.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">,</span> <span class="nv">queryCompletion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <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>query</em> </code> </td> <td> <div> - <p>The optional query to use when gathering <code>UsergridEntity</code> objects.</p> + <p>The query to use when gathering <code>UsergridEntity</code> objects.</p> </div> </td> @@ -1588,7 +1662,7 @@ within the UsergridSDK library.</p> <tr> <td> <code> - <em>completion</em> + <em>queryCompletion</em> </code> </td> <td> @@ -3620,7 +3694,7 @@ within the UsergridSDK library.</p> </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html index 81a614c..3e5118a 100644 --- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html +++ b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html @@ -392,7 +392,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html index ca7c393..b473cd1 100644 --- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html +++ b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html @@ -684,7 +684,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html index 7fbc041..393f872 100644 --- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html +++ b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html @@ -338,7 +338,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html index 74d63a8..9db7a66 100644 --- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html +++ b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html @@ -540,7 +540,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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/c638c774/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridClient.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridClient.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridClient.html index 5f897be..0b1b378 100644 --- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridClient.html +++ b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridClient.html @@ -285,6 +285,33 @@ <li class="item"> <div> <code> + <a name="/s:vC11UsergridSDK14UsergridClient28persistCurrentUserInKeychainSb"></a> + <a name="//apple_ref/swift/Property/persistCurrentUserInKeychain" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK14UsergridClient28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Whether or not the current user will be saved and restored from the keychain.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> <a name="/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_"></a> <a name="//apple_ref/swift/Property/currentUser" class="dashAnchor"></a> <a class="token" href="#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">currentUser</a> @@ -1628,9 +1655,9 @@ <li class="item"> <div> <code> - <a name="/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/GET(_:query:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS5queryGSqCS_13UsergridQuery_10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:query:completion:)</a> + <a name="/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> + <a name="//apple_ref/swift/Method/GET(_:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFS0_FTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:completion:)</a> </code> </div> <div class="height-container"> @@ -1638,14 +1665,14 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Gets a group of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects of a given type with an optional query.</p> + <p>Gets a group of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects of a given type.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> </div> </div> @@ -1669,12 +1696,59 @@ <tr> <td> <code> + <em>completion</em> + </code> + </td> + <td> + <div> + <p>The optional completion block that will be called once the request has completed.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK14UsergridClient3GETFS0_FTCS_13UsergridQuery15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_"></a> + <a name="//apple_ref/swift/Method/GET(_:queryCompletion:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFS0_FTCS_13UsergridQuery15queryCompletionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:queryCompletion:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Gets a group of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects using a given query.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">GET</span><span class="p">(</span><span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">,</span> <span class="nv">queryCompletion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?</span> <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>query</em> </code> </td> <td> <div> - <p>The optional query to use when gathering <code>UsergridEntity</code> objects.</p> + <p>The query to use when gathering <code>UsergridEntity</code> objects.</p> </div> </td> @@ -1682,7 +1756,7 @@ <tr> <td> <code> - <em>completion</em> + <em>queryCompletion</em> </code> </td> <td> @@ -3716,7 +3790,7 @@ </section> </section> <section id="footer"> - <p>© 2016 <a class="link" href="https://github.com/RobertWalsh/UsergridSDK"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-08)</p> + <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift"; target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.5.0</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> </section> </article>
