http://git-wip-us.apache.org/repos/asf/usergrid/blob/c733f01f/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridRequest.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridRequest.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridRequest.html new file mode 100644 index 0000000..0405ff5 --- /dev/null +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridRequest.html @@ -0,0 +1,619 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridRequest Class Reference</title> + <link rel="stylesheet" type="text/css" href="../css/jazzy.css" /> + <link rel="stylesheet" type="text/css" href="../css/highlight.css" /> + <meta charset='utf-8'> + <script src="../js/jquery.min.js" defer></script> + <script src="../js/jazzy.js" defer></script> + + </head> + <body> + <a name="//apple_ref/swift/Class/UsergridRequest" class="dashAnchor"></a> + <a title="UsergridRequest Class Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html"> Docs</a> (100% documented)</p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html"> Reference</a> + <img id="carat" src="../img/carat.png" /> + UsergridRequest Class Reference + </p> + </div> + <div class="content-wrapper"> + <nav class="sidebar"> + <ul class="nav-groups"> + <li class="nav-group-name"> + <a href="../Classes.html">Classes</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Classes/Usergrid.html">Usergrid</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridAsset.html">UsergridAsset</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridAuth.html">UsergridAuth</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridClient.html">UsergridClient</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridDevice.html">UsergridDevice</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridEntity.html">UsergridEntity</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridQuery.html">UsergridQuery</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridRequest.html">UsergridRequest</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridResponse.html">UsergridResponse</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridResponseError.html">UsergridResponseError</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridUser.html">UsergridUser</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Global Variables.html">Global Variables</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Global Variables.html#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Enums.html">Enums</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridDirection.html">UsergridDirection</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridHttpMethod.html">UsergridHttpMethod</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Extensions.html">Extensions</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Extensions/NSDate.html">NSDate</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Typealiases.html">Typealiases</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a> + </li> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>UsergridRequest</h1> + <div class="declaration"> + <div class="language"> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridRequest</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + + </div> + </div> + <p>The UsergridRequest class incapsulates the properties that all requests made by the SDK have in common. </p> + +<p>This class is also functions to create <code>NSURLRequest</code> objects based on the properties of the class.</p> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <div class="task-name-container"> + <a name="/Instance%20Properties"></a> + <a name="//apple_ref/swift/Section/Instance Properties" class="dashAnchor"></a> + <a href="#/Instance%20Properties"> + <h3 class="section-name">Instance Properties</h3> + </a> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK15UsergridRequest6methodOS_18UsergridHttpMethod"></a> + <a name="//apple_ref/swift/Property/method" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest6methodOS_18UsergridHttpMethod">method</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The HTTP method.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">method</span><span class="p">:</span> <span class="kt">UsergridHttpMethod</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK15UsergridRequest7baseUrlSS"></a> + <a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest7baseUrlSS">baseUrl</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The base URL.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">baseUrl</span><span class="p">:</span> <span class="kt">String</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK15UsergridRequest5pathsGSqGSaSS__"></a> + <a name="//apple_ref/swift/Property/paths" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest5pathsGSqGSaSS__">paths</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The paths to append to the base URL.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">paths</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK15UsergridRequest5queryGSqCS_13UsergridQuery_"></a> + <a name="//apple_ref/swift/Property/query" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest5queryGSqCS_13UsergridQuery_">query</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The query to append to the URL.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK15UsergridRequest4authGSqCS_12UsergridAuth_"></a> + <a name="//apple_ref/swift/Property/auth" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest4authGSqCS_12UsergridAuth_">auth</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The auth that will be used.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">auth</span><span class="p">:</span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK15UsergridRequest7headersGSqGVs10DictionarySSSS__"></a> + <a name="//apple_ref/swift/Property/headers" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest7headersGSqGVs10DictionarySSSS__">headers</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The headers to add to the request.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">headers</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</span><span class="p">]?</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK15UsergridRequest8jsonBodyGSqPs9AnyObject__"></a> + <a name="//apple_ref/swift/Property/jsonBody" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest8jsonBodyGSqPs9AnyObject__">jsonBody</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The JSON body that will be set on the request. Can be either a valid JSON object or NSData.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">jsonBody</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">?</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK15UsergridRequest11queryParamsGSqGVs10DictionarySSSS__"></a> + <a name="//apple_ref/swift/Property/queryParams" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK15UsergridRequest11queryParamsGSqGVs10DictionarySSSS__">queryParams</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The query params that will be set on the request.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">queryParams</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</span><span class="p">]?</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <div class="task-name-container"> + <a name="/Initialization"></a> + <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a> + <a href="#/Initialization"> + <h3 class="section-name">Initialization</h3> + </a> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK15UsergridRequestcFT6methodOS_18UsergridHttpMethod7baseUrlSS5pathsGSqGSaSS__5queryGSqCS_13UsergridQuery_4authGSqCS_12UsergridAuth_7headersGSqGVs10DictionarySSSS__8jsonBodyGSqPs9AnyObject__11queryParamsGSqGS4_SSSS___S0_"></a> + <a name="//apple_ref/swift/Method/init(method:baseUrl:paths:query:auth:headers:jsonBody:queryParams:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK15UsergridRequestcFT6methodOS_18UsergridHttpMethod7baseUrlSS5pathsGSqGSaSS__5queryGSqCS_13UsergridQuery_4authGSqCS_12UsergridAuth_7headersGSqGVs10DictionarySSSS__8jsonBodyGSqPs9AnyObject__11queryParamsGSqGS4_SSSS___S0_">init(method:baseUrl:paths:query:auth:headers:jsonBody:queryParams:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The designated initializer for <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> objects.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span><span class="kt">UsergridHttpMethod</span><span class="p">,</span> + <span class="nv">baseUrl</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> + <span class="nv">paths</span><span class="p">:[</span><span class="kt">String</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> + <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">auth</span><span class="p">:</span><span class="kt">UsergridAuth</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> + <span class="nv">headers</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> + <span class="nv">jsonBody</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> + <span class="nv">queryParams</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>method</em> + </code> + </td> + <td> + <div> + <p>The HTTP method.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>baseUrl</em> + </code> + </td> + <td> + <div> + <p>The base URL.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>paths</em> + </code> + </td> + <td> + <div> + <p>The optional paths to append to the base URL.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>query</em> + </code> + </td> + <td> + <div> + <p>The optional query to append to the URL.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>auth</em> + </code> + </td> + <td> + <div> + <p>The optional <code>UsergridAuth</code> that will be used in the Authorization header.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>headers</em> + </code> + </td> + <td> + <div> + <p>The optional headers.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>jsonBody</em> + </code> + </td> + <td> + <div> + <p>The optional JSON body. Can be either a valid JSON object or NSData.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>queryParams</em> + </code> + </td> + <td> + <div> + <p>The optional query params to be appended to the request url.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code>.</p> + + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <div class="task-name-container"> + <a name="/Instance%20Methods"></a> + <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a> + <a href="#/Instance%20Methods"> + <h3 class="section-name">Instance Methods</h3> + </a> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK15UsergridRequest17buildNSURLRequestFT_CSo12NSURLRequest"></a> + <a name="//apple_ref/swift/Method/buildNSURLRequest()" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK15UsergridRequest17buildNSURLRequestFT_CSo12NSURLRequest">buildNSURLRequest()</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Constructs a <code>NSURLRequest</code> object with this objects instance properties.</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">buildNSURLRequest</span><span class="p">()</span> <span class="o">-></span> <span class="kt">NSURLRequest</span></code></pre> + + </div> + </div> + <div> + <h4>Return Value</h4> + <p>An initialized and configured <code>NSURLRequest</code> object.</p> + + </div> + </section> + </div> + </li> + </ul> + </div> + </section> + </section> + <section id="footer"> + <p>© 2016 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p> + <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.5.0</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> + </section> + </article> + </div> + </body> +</div> +</html>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/c733f01f/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html index afc0714..6ff0433 100644 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridResponse.html @@ -7,13 +7,14 @@ <meta charset='utf-8'> <script src="../js/jquery.min.js" defer></script> <script src="../js/jazzy.js" defer></script> + </head> <body> <a name="//apple_ref/swift/Class/UsergridResponse" class="dashAnchor"></a> <a title="UsergridResponse Class Reference"></a> <header> <div class="content-wrapper"> - <p><a href="../index.html"> Docs</a> (97% documented)</p> + <p><a href="../index.html"> Docs</a> (100% documented)</p> </div> </header> <div class="content-wrapper"> @@ -27,7 +28,7 @@ <nav class="sidebar"> <ul class="nav-groups"> <li class="nav-group-name"> - <a href="../Classes.html">Classes</a> + <a href="../Classes.html">Classes</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="../Classes/Usergrid.html">Usergrid</a> @@ -39,6 +40,9 @@ <a href="../Classes/UsergridAsset.html">UsergridAsset</a> </li> <li class="nav-group-task"> + <a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a> + </li> + <li class="nav-group-task"> <a href="../Classes/UsergridAuth.html">UsergridAuth</a> </li> <li class="nav-group-task"> @@ -60,9 +64,15 @@ <a href="../Classes/UsergridQuery.html">UsergridQuery</a> </li> <li class="nav-group-task"> + <a href="../Classes/UsergridRequest.html">UsergridRequest</a> + </li> + <li class="nav-group-task"> <a href="../Classes/UsergridResponse.html">UsergridResponse</a> </li> <li class="nav-group-task"> + <a href="../Classes/UsergridResponseError.html">UsergridResponseError</a> + </li> + <li class="nav-group-task"> <a href="../Classes/UsergridUser.html">UsergridUser</a> </li> <li class="nav-group-task"> @@ -71,10 +81,18 @@ </ul> </li> <li class="nav-group-name"> - <a href="../Enums.html">Enums</a> + <a href="../Global Variables.html">Global Variables</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> - <a href="../Enums/UsergridAuthFallback.html">UsergridAuthFallback</a> + <a href="../Global Variables.html#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Enums.html">Enums</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a> </li> <li class="nav-group-task"> <a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a> @@ -86,6 +104,9 @@ <a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a> </li> <li class="nav-group-task"> + <a href="../Enums/UsergridHttpMethod.html">UsergridHttpMethod</a> + </li> + <li class="nav-group-task"> <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a> </li> <li class="nav-group-task"> @@ -100,7 +121,15 @@ </ul> </li> <li class="nav-group-name"> - <a href="../Typealiases.html">Typealiases</a> + <a href="../Extensions.html">Extensions</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Extensions/NSDate.html">NSDate</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Typealiases.html">Typealiases</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="../Typealiases.html#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a> @@ -120,6 +149,12 @@ <li class="nav-group-task"> <a href="../Typealiases.html#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a> </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a> + </li> </ul> </li> </ul> @@ -129,27 +164,27 @@ <section class="section"> <h1>UsergridResponse</h1> <div class="declaration"> - <div class="Swift"> + <div class="language"> <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridResponse</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre> </div> </div> <p><code>UsergridResponse</code> is the core class that handles both successful and unsuccessful HTTP responses from Usergrid. </p> -<p>If a request is successful, any entities returned in the response will be automatically parsed into <code>UsergridEntity</code> objects and pushed to the <code>entities</code> property.</p> +<p>If a request is successful, any entities returned in the response will be automatically parsed into <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects and pushed to the <code>entities</code> property.</p> -<p>If a request fails, the <code>errorName</code> and <code>errorDescription</code> will contain information about the problem encountered.</p> +<p>If a request fails, the <code>UsergridResponseError.error</code> property will contain information about the problem encountered.</p> </section> <section class="section task-group-section"> <div class="task-group"> - <div class="task-name-container"> - <a name="/Instance%20Properties"></a> - <a name="//apple_ref/swift/Section/Instance Properties" class="dashAnchor"></a> - <a href="#/Instance%20Properties"> - <h3 class="section-name">Instance Properties</h3> - </a> - </div> + <div class="task-name-container"> + <a name="/Instance%20Properties"></a> + <a name="//apple_ref/swift/Section/Instance Properties" class="dashAnchor"></a> + <a href="#/Instance%20Properties"> + <h3 class="section-name">Instance Properties</h3> + </a> + </div> <ul> <li class="item"> <div> @@ -169,7 +204,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">weak</span> <span class="k">var</span> <span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">?</span></code></pre> @@ -181,9 +216,9 @@ <li class="item"> <div> <code> - <a name="/s:vC11UsergridSDK16UsergridResponse12responseJSONGSqGVSs10DictionarySSPSs9AnyObject___"></a> + <a name="/s:vC11UsergridSDK16UsergridResponse12responseJSONGSqGVs10DictionarySSPs9AnyObject___"></a> <a name="//apple_ref/swift/Property/responseJSON" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse12responseJSONGSqGVSs10DictionarySSPSs9AnyObject___">responseJSON</a> + <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse12responseJSONGSqGVs10DictionarySSPs9AnyObject___">responseJSON</a> </code> </div> <div class="height-container"> @@ -196,7 +231,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">responseJSON</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">]?</span></code></pre> @@ -223,7 +258,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">query</span><span class="p">:</span> <span class="kt">UsergridQuery</span><span class="p">?</span></code></pre> @@ -250,7 +285,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">cursor</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> @@ -277,7 +312,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">entities</span><span class="p">:</span> <span class="p">[</span><span class="kt">UsergridEntity</span><span class="p">]?</span></code></pre> @@ -289,9 +324,9 @@ <li class="item"> <div> <code> - <a name="/s:vC11UsergridSDK16UsergridResponse7headersGSqGVSs10DictionarySSSS__"></a> + <a name="/s:vC11UsergridSDK16UsergridResponse7headersGSqGVs10DictionarySSSS__"></a> <a name="//apple_ref/swift/Property/headers" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse7headersGSqGVSs10DictionarySSSS__">headers</a> + <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse7headersGSqGVs10DictionarySSSS__">headers</a> </code> </div> <div class="height-container"> @@ -304,7 +339,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">headers</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</span><span class="p">]?</span></code></pre> @@ -331,7 +366,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">statusCode</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span></code></pre> @@ -343,9 +378,9 @@ <li class="item"> <div> <code> - <a name="/s:vC11UsergridSDK16UsergridResponse9errorNameGSqSS_"></a> - <a name="//apple_ref/swift/Property/errorName" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse9errorNameGSqSS_">errorName</a> + <a name="/s:vC11UsergridSDK16UsergridResponse5errorGSqCS_21UsergridResponseError_"></a> + <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse5errorGSqCS_21UsergridResponseError_">error</a> </code> </div> <div class="height-container"> @@ -353,14 +388,14 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>The error’s name.</p> + <p>The error object containing error information if one occurred.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">errorName</span> <span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> + <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">UsergridResponseError</span><span class="p">?</span></code></pre> </div> </div> @@ -370,9 +405,9 @@ <li class="item"> <div> <code> - <a name="/s:vC11UsergridSDK16UsergridResponse16errorDescriptionGSqSS_"></a> - <a name="//apple_ref/swift/Property/errorDescription" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse16errorDescriptionGSqSS_">errorDescription</a> + <a name="/s:vC11UsergridSDK16UsergridResponse2okSb"></a> + <a name="//apple_ref/swift/Property/ok" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse2okSb">ok</a> </code> </div> <div class="height-container"> @@ -380,41 +415,14 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>The error’s description.</p> + <p>Returns true if the HTTP status code from the response is less than 400.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">errorDescription</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK16UsergridResponse9exceptionGSqSS_"></a> - <a name="//apple_ref/swift/Property/exception" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse9exceptionGSqSS_">exception</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The exception.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="Swift"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">exception</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">ok</span> <span class="p">:</span> <span class="kt">Bool</span></code></pre> </div> </div> @@ -434,12 +442,12 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>The count of <code>entities</code>.</p> + <p>The count of <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">count</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span><span class="p">?</span><span class="o">.</span><span class="n">count</span> <span class="p">??</span> <span class="mi">0</span> <span class="p">}</span></code></pre> @@ -461,12 +469,12 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>The first entity in <code>entities</code>.</p> + <p>The first entity in <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">first</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span><span class="p">?</span><span class="o">.</span><span class="n">first</span> <span class="p">}</span></code></pre> @@ -488,12 +496,12 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>The last entity in <code>entities</code>.</p> + <p>The last entity in <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">last</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span><span class="p">?</span><span class="o">.</span><span class="n">last</span> <span class="p">}</span></code></pre> @@ -515,12 +523,12 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>The first entity in <code>entities</code>.</p> + <p>The first entity in <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse8entitiesGSqGSaCS_14UsergridEntity__">entities</a></code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">entity</span><span class="p">:</span> <span class="kt">UsergridEntity</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">first</span> <span class="p">}</span></code></pre> @@ -542,12 +550,12 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>The <code>UsergridUser</code> entity.</p> + <p>The <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> entity.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span><span class="p">?</span><span class="o">.</span><span class="n">first</span> <span class="k">as?</span> <span class="kt">UsergridUser</span> <span class="p">}</span></code></pre> @@ -569,12 +577,12 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>An array of <code>UsergridUser</code> entities.</p> + <p>An array of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> entities.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">users</span><span class="p">:</span> <span class="p">[</span><span class="kt">UsergridUser</span><span class="p">]?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">entities</span> <span class="k">as?</span> <span class="p">[</span><span class="kt">UsergridUser</span><span class="p">]</span> <span class="p">}</span></code></pre> @@ -601,7 +609,7 @@ </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">hasNextPage</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">cursor</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre> @@ -610,23 +618,104 @@ </section> </div> </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK16UsergridResponse11stringValueSS"></a> + <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse11stringValueSS">stringValue</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The string value.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">stringValue</span> <span class="p">:</span> <span class="kt">String</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK16UsergridResponse11descriptionSS"></a> + <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse11descriptionSS">description</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The description.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">override</span> <span class="k">var</span> <span class="nv">description</span> <span class="p">:</span> <span class="kt">String</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK16UsergridResponse16debugDescriptionSS"></a> + <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK16UsergridResponse16debugDescriptionSS">debugDescription</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>The debug description.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">override</span> <span class="k">var</span> <span class="nv">debugDescription</span> <span class="p">:</span> <span class="kt">String</span></code></pre> + + </div> + </div> + </section> + </div> + </li> </ul> </div> <div class="task-group"> - <div class="task-name-container"> - <a name="/Initialization"></a> - <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a> - <a href="#/Initialization"> - <h3 class="section-name">Initialization</h3> - </a> - </div> + <div class="task-name-container"> + <a name="/Initialization"></a> + <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a> + <a href="#/Initialization"> + <h3 class="section-name">Initialization</h3> + </a> + </div> <ul> <li class="item"> <div> <code> - <a name="/s:FC11UsergridSDK16UsergridResponsecFMS0_FT6clientGSqCS_14UsergridClient_9errorNameGSqSS_16errorDescriptionGSqSS__S0_"></a> + <a name="/s:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_9errorNameSS16errorDescriptionSS_S0_"></a> <a name="//apple_ref/swift/Method/init(client:errorName:errorDescription:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK16UsergridResponsecFMS0_FT6clientGSqCS_14UsergridClient_9errorNameGSqSS_16errorDescriptionGSqSS__S0_">init(client:errorName:errorDescription:)</a> + <a class="token" href="#/s:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_9errorNameSS16errorDescriptionSS_S0_">init(client:errorName:errorDescription:)</a> </code> </div> <div class="height-container"> @@ -634,16 +723,16 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Designated initializer for <code>UsergridResponse</code> objects that contain errors.</p> + <p>Designated initializer for <code><a href="../Classes/UsergridResponse.html">UsergridResponse</a></code> objects that contain errors.</p> <p>These types of responses are usually created because request conditions are not met.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">?,</span> <span class="nv">errorName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">errorDescription</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">?,</span> <span class="nv">errorName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">errorDescription</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> </div> </div> @@ -695,7 +784,7 @@ </div> <div> <h4>Return Value</h4> - <p>A new instance of <code>UsergridResponse</code>.</p> + <p>A new instance of <code><a href="../Classes/UsergridResponse.html">UsergridResponse</a></code>.</p> </div> </section> @@ -704,9 +793,9 @@ <li class="item"> <div> <code> - <a name="/s:FC11UsergridSDK16UsergridResponsecFMS0_FT6clientGSqCS_14UsergridClient_4dataGSqCSo6NSData_8responseGSqCSo17NSHTTPURLResponse_5errorGSqCSo7NSError_5queryGSqCS_13UsergridQuery__S0_"></a> + <a name="/s:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_4dataGSqCSo6NSData_8responseGSqCSo17NSHTTPURLResponse_5errorGSqCSo7NSError_5queryGSqCS_13UsergridQuery__S0_"></a> <a name="//apple_ref/swift/Method/init(client:data:response:error:query:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK16UsergridResponsecFMS0_FT6clientGSqCS_14UsergridClient_4dataGSqCSo6NSData_8responseGSqCSo17NSHTTPURLResponse_5errorGSqCSo7NSError_5queryGSqCS_13UsergridQuery__S0_">init(client:data:response:error:query:)</a> + <a class="token" href="#/s:FC11UsergridSDK16UsergridResponsecFT6clientGSqCS_14UsergridClient_4dataGSqCSo6NSData_8responseGSqCSo17NSHTTPURLResponse_5errorGSqCSo7NSError_5queryGSqCS_13UsergridQuery__S0_">init(client:data:response:error:query:)</a> </code> </div> <div class="height-container"> @@ -714,12 +803,12 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Designated initializer for <code>UsergridResponse</code> objects finished but still may contain errors.</p> + <p>Designated initializer for <code><a href="../Classes/UsergridResponse.html">UsergridResponse</a></code> objects finished but still may contain errors.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span><span class="kt">UsergridClient</span><span class="p">?,</span> <span class="nv">data</span><span class="p">:</span><span class="kt">NSData</span><span class="p">?,</span> <span class="nv">response</span><span class="p">:</span><span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span><span class="kt">NSError</span><span class="p">?,</span> <span class="nv">query</span><span class="p">:</span><span class="kt">UsergridQuery</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> @@ -799,7 +888,7 @@ </div> <div> <h4>Return Value</h4> - <p>A new instance of <code>UsergridResponse</code>.</p> + <p>A new instance of <code><a href="../Classes/UsergridResponse.html">UsergridResponse</a></code>.</p> </div> </section> @@ -808,20 +897,20 @@ </ul> </div> <div class="task-group"> - <div class="task-name-container"> - <a name="/Instance%20Methods"></a> - <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a> - <a href="#/Instance%20Methods"> - <h3 class="section-name">Instance Methods</h3> - </a> - </div> + <div class="task-name-container"> + <a name="/Instance%20Methods"></a> + <a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a> + <a href="#/Instance%20Methods"> + <h3 class="section-name">Instance Methods</h3> + </a> + </div> <ul> <li class="item"> <div> <code> - <a name="/s:FC11UsergridSDK16UsergridResponse12loadNextPageFS0_FFT8responseS0__T_T_"></a> + <a name="/s:FC11UsergridSDK16UsergridResponse12loadNextPageFFT8responseS0__T_T_"></a> <a name="//apple_ref/swift/Method/loadNextPage(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK16UsergridResponse12loadNextPageFS0_FFT8responseS0__T_T_">loadNextPage(_:)</a> + <a class="token" href="#/s:FC11UsergridSDK16UsergridResponse12loadNextPageFFT8responseS0__T_T_">loadNextPage(_:)</a> </code> </div> <div class="height-container"> @@ -829,14 +918,14 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Attempts to load the next page of <code>UsergridEntity</code> objects. </p> + <p>Attempts to load the next page of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects. </p> -<p>This requires a <code>cursor</code> to be valid as well as a <code>path</code> key within the response JSON.</p> +<p>This requires a <code><a href="../Classes/UsergridResponse.html#/s:vC11UsergridSDK16UsergridResponse6cursorGSqSS_">cursor</a></code> to be valid as well as a <code>path</code> key within the response JSON.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">loadNextPage</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">)</span></code></pre> @@ -870,8 +959,8 @@ </section> </section> <section id="footer"> - <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-12-18)</p> - <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.3.2</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> + <p>© 2016 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p> + <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.5.0</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> </section> </article> </div>
