http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/Classes/UsergridClient.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/Classes/UsergridClient.html b/sdks/swift/docs/Classes/UsergridClient.html deleted file mode 100644 index 09c2175..0000000 --- a/sdks/swift/docs/Classes/UsergridClient.html +++ /dev/null @@ -1,3873 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <title>UsergridClient 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/UsergridClient" class="dashAnchor"></a> - <a title="UsergridClient 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" /> - UsergridClient 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>UsergridClient</h1> - <div class="declaration"> - <div class="language"> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridClient</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre> - - </div> - </div> - <p>The <code>UsergridClient</code> class is the base handler for making client connections to and managing relationships with Usergrid’s API.</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:vC11UsergridSDK14UsergridClient6configCS_20UsergridClientConfig"></a> - <a name="//apple_ref/swift/Property/config" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridClient6configCS_20UsergridClientConfig">config</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The configuration object used by the client.</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">config</span><span class="p">:</span> <span class="kt">UsergridClientConfig</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK14UsergridClient5appIdSS"></a> - <a name="//apple_ref/swift/Property/appId" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridClient5appIdSS">appId</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The application identifier.</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">appId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">appId</span> <span class="p">}</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK14UsergridClient5orgIdSS"></a> - <a name="//apple_ref/swift/Property/orgId" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridClient5orgIdSS">orgId</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The organization identifier.</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">orgId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">orgId</span> <span class="p">}</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK14UsergridClient7baseUrlSS"></a> - <a name="//apple_ref/swift/Property/baseUrl" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridClient7baseUrlSS">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 that all calls will be made with.</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">baseUrl</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">baseUrl</span> <span class="p">}</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK14UsergridClient12clientAppURLSS"></a> - <a name="//apple_ref/swift/Property/clientAppURL" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridClient12clientAppURLSS">clientAppURL</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The constructed URL string based on the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’s <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient7baseUrlSS">baseUrl</a></code>, <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient5orgIdSS">orgId</a></code>, and <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient5appIdSS">appId</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">clientAppURL</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="s">"</span><span class="se">\(</span><span class="n">baseUrl</span><span class="se">)</span><span class="s">/</span><span class="se">\(</span><span class="n">orgId</span><span class="se">)</span><span class="s">/</span><span class="se">\(</span><span class="n">appId</span><span class="se">)</span><span class="s">"</span> <span class="p">}</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <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> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The currently logged in <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">internal(set)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">currentUser</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK14UsergridClient8userAuthGSqCS_16UsergridUserAuth_"></a> - <a name="//apple_ref/swift/Property/userAuth" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridClient8userAuthGSqCS_16UsergridUserAuth_">userAuth</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> which consists of the token information from the <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">currentUser</a></code> property.</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">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">currentUser</span><span class="p">?</span><span class="o">.</span><span class="n">auth</span> <span class="p">}</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_"></a> - <a name="//apple_ref/swift/Property/appAuth" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_">appAuth</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The application level <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object. Can be set manually but must call <code>authenticateApp</code> to retrive token.</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">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">?</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode"></a> - <a name="//apple_ref/swift/Property/authMode" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode">authMode</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/UsergridAuthMode.html">UsergridAuthMode</a></code> value used to determine what type of token will be sent, 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="k">var</span> <span class="nv">authMode</span><span class="p">:</span> <span class="kt">UsergridAuthMode</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:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS_S0_"></a> - <a name="//apple_ref/swift/Method/init(orgId:appId:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS_S0_">init(orgId:appId:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Initializes instances 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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre> - - </div> - </div> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>orgId</em> - </code> - </td> - <td> - <div> - <p>The organization identifier.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>appId</em> - </code> - </td> - <td> - <div> - <p>The application identifier.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - <div> - <h4>Return Value</h4> - <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS7baseUrlSS_S0_"></a> - <a name="//apple_ref/swift/Method/init(orgId:appId:baseUrl:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT5orgIdSS5appIdSS7baseUrlSS_S0_">init(orgId:appId:baseUrl:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Initializes instances 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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">orgId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">baseUrl</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre> - - </div> - </div> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>orgId</em> - </code> - </td> - <td> - <div> - <p>The organization identifier.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>appId</em> - </code> - </td> - <td> - <div> - <p>The application identifier.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>baseUrl</em> - </code> - </td> - <td> - <div> - <p>The base URL that all calls will be made with.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - <div> - <h4>Return Value</h4> - <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClientcFT13configurationCS_20UsergridClientConfig_S0_"></a> - <a name="//apple_ref/swift/Method/init(configuration:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT13configurationCS_20UsergridClientConfig_S0_">init(configuration:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Initializes instances 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="nf">init</span><span class="p">(</span><span class="nv">configuration</span><span class="p">:</span><span class="kt">UsergridClientConfig</span><span class="p">)</span></code></pre> - - </div> - </div> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>configuration</em> - </code> - </td> - <td> - <div> - <p>The configuration for the client to be set up with.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - <div> - <h4>Return Value</h4> - <p>The new instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - </section> - </div> - </li> - </ul> - </div> - <div class="task-group"> - <div class="task-name-container"> - <a name="/NSCoding"></a> - <a name="//apple_ref/swift/Section/NSCoding" class="dashAnchor"></a> - <a href="#/NSCoding"> - <h3 class="section-name">NSCoding</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClientcFT5coderCSo7NSCoder_GSqS0__"></a> - <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClientcFT5coderCSo7NSCoder_GSqS0__">init(coder:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>NSCoding protocol initializer.</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">required</span> <span class="nf">init</span><span class="p">?(</span><span class="n">coder</span> <span class="nv">aDecoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre> - - </div> - </div> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>aDecoder</em> - </code> - </td> - <td> - <div> - <p>The decoder.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - <div> - <h4>Return Value</h4> - <p>A decoded <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> object.</p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient15encodeWithCoderFCSo7NSCoderT_"></a> - <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15encodeWithCoderFCSo7NSCoderT_">encodeWithCoder(_:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>NSCoding protocol encoder.</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">encodeWithCoder</span><span class="p">(</span><span class="nv">aCoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre> - - </div> - </div> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>aCoder</em> - </code> - </td> - <td> - <div> - <p>The encoder.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - </ul> - </div> - <div class="task-group"> - <div class="task-name-container"> - <a name="/Device%20Registration/Push%20Notifications"></a> - <a name="//apple_ref/swift/Section/Device Registration/Push Notifications" class="dashAnchor"></a> - <a href="#/Device%20Registration/Push%20Notifications"> - <h3 class="section-name">Device Registration/Push Notifications</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/applyPushToken(_:notifierID:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:notifierID:completion:)</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 push token for the given notifier ID and performs a PUT request to update the shared <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance.</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">applyPushToken</span><span class="p">(</span><span class="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</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> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>pushToken</em> - </code> - </td> - <td> - <div> - <p>The push token from Apple.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>notifierID</em> - </code> - </td> - <td> - <div> - <p>The Usergrid notifier ID.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>completion</em> - </code> - </td> - <td> - <div> - <p>The completion block.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/applyPushToken(_:pushToken:notifierID:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">applyPushToken(_:pushToken:notifierID:completion:)</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 push token for the given notifier ID and performs a PUT request to update the given <code><a href="../Classes/UsergridDevice.html">UsergridDevice</a></code> instance.</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">applyPushToken</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="nv">pushToken</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">notifierID</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> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>device</em> - </code> - </td> - <td> - <div> - <p>The <code>UsergridDevice</code> object.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>pushToken</em> - </code> - </td> - <td> - <div> - <p>The push token from Apple.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>notifierID</em> - </code> - </td> - <td> - <div> - <p>The Usergrid notifier ID.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>completion</em> - </code> - </td> - <td> - <div> - <p>The completion block.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - </ul> - </div> - <div class="task-group"> - <div class="task-name-container"> - <a name="/Authorization%20and%20User%20Management"></a> - <a name="//apple_ref/swift/Section/Authorization and User Management" class="dashAnchor"></a> - <a href="#/Authorization%20and%20User%20Management"> - <h3 class="section-name">Authorization and User Management</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient15authForRequestsFT_GSqCS_12UsergridAuth_"></a> - <a name="//apple_ref/swift/Method/authForRequests()" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authForRequestsFT_GSqCS_12UsergridAuth_">authForRequests()</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Determines the <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object that will be used for all outgoing requests made.</p> - -<p>If there is a valid temporary <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> set by the functions <code>usingAuth</code> or <code>usingToken</code> it will return that.</p> - -<p>If there is a <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> logged in and the token of that user is valid then it will return that.</p> - -<p>Otherwise, if the <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient8authModeOS_16UsergridAuthMode">authMode</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</p> - - </div> - <div class="declaration"> - <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">authForRequests</span><span class="p">()</span> <span class="o">-></span> <span class="kt">UsergridAuth</span><span class="p">?</span></code></pre> - - </div> - </div> - <div> - <h4>Return Value</h4> - <p>The <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> if one is found or nil if not.</p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient9usingAuthFCS_12UsergridAuthDS0_"></a> - <a name="//apple_ref/swift/Method/usingAuth(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient9usingAuthFCS_12UsergridAuthDS0_">usingAuth(_:)</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 client’s <code>tempAuth</code> property using the passed in <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code>.</p> - -<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">usingAuth</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="k">Self</span></code></pre> - - </div> - </div> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>auth</em> - </code> - </td> - <td> - <div> - <p>The <code>UsergridAuth</code> object to temporarily use for authentication.</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:FC11UsergridSDK14UsergridClient10usingTokenFSSDS0_"></a> - <a name="//apple_ref/swift/Method/usingToken(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10usingTokenFSSDS0_">usingToken(_:)</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 client’s <code>tempAuth</code> property using the passed in token.</p> - -<p>This will cause the next CRUD method performed by the client to use the <code>tempAuth</code> property once and will then reset.</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">usingToken</span><span class="p">(</span><span class="nv">token</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>auth</em> - </code> - </td> - <td> - <div> - <p>The access token to temporarily use for authentication.</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:FC11UsergridSDK14UsergridClient15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_"></a> - <a name="//apple_ref/swift/Method/authenticateApp(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is contained this 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">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>completion</em> - </code> - </td> - <td> - <div> - <p>The completion block that will be called after authentication has completed.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_"></a> - <a name="//apple_ref/swift/Method/authenticateApp(_:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_">authenticateApp(_:completion:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Authenticates with the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> that is passed in.</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">authenticateApp</span><span class="p">(</span><span class="nv">appAuth</span><span class="p">:</span> <span class="kt">UsergridAppAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridAppAuthCompletionBlock</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>auth</em> - </code> - </td> - <td> - <div> - <p>The <code>UsergridAppAuth</code> that will be authenticated.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>completion</em> - </code> - </td> - <td> - <div> - <p>The completion block that will be called after authentication has completed.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a> - <a name="//apple_ref/swift/Method/authenticateUser(_:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:completion:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in.</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">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em> - </code> - </td> - <td> - <div> - <p>The <code>UsergridUserAuth</code> that will be authenticated.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>completion</em> - </code> - </td> - <td> - <div> - <p>The completion block that will be called after authentication has completed.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a> - <a name="//apple_ref/swift/Method/authenticateUser(_:setAsCurrentUser:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient16authenticateUserFTCS_16UsergridUserAuth16setAsCurrentUserSb10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_">authenticateUser(_:setAsCurrentUser:completion:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Authenticates with the <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> that is passed in.</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">authenticateUser</span><span class="p">(</span><span class="nv">userAuth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">,</span> <span class="nv">setAsCurrentUser</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridUserAuthCompletionBlock</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>auth</em> - </code> - </td> - <td> - <div> - <p>The <code>UsergridUserAuth</code> that will be authenticated.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>setAsCurrentUser</em> - </code> - </td> - <td> - <div> - <p>If the authenticated user should be set as the <code>UsergridClient.currentUser</code>.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>completion</em> - </code> - </td> - <td> - <div> - <p>The completion block that will be called after authentication has completed.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a> - <a name="//apple_ref/swift/Method/resetPassword(_:old:new:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:old:new:completion:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Changes the given <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password.</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">resetPassword</span><span class="p">(</span><span class="nv">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">,</span> <span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserResetPasswordCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> - - </div> - </div> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>user</em> - </code> - </td> - <td> - <div> - <p>The user.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>old</em> - </code> - </td> - <td> - <div> - <p>The old password.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>new</em> - </code> - </td> - <td> - <div> - <p>The new password.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>completion</em> - </code> - </td> - <td> - <div> - <p>The optional completion block.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_">logoutCurrentUser(_:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Logs out the current user locally and remotely.</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">logoutCurrentUser</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>completion</em> - </code> - </td> - <td> - <div> - <p>The completion block that will be called after logout has completed.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/logoutUserAllTokens(_:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUserAllTokens(_:completion:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Logs out the user remotely with the given tokens.</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">logoutUserAllTokens</span><span class="p">(</span><span class="nv">uuidOrUsername</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> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>completion</em> - </code> - </td> - <td> - <div> - <p>The completion block that will be called after logout has completed.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/logoutUser(_:token:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_">logoutUser(_:token:completion:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Logs out a user with the give UUID or username using the shared instance of <code>UsergridCient</code>.</p> - -<p>Passing in a token will log out the user for just that token. Passing in nil for the token will logout the user for all tokens.</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">logoutUser</span><span class="p">(</span><span class="nv">uuidOrUsername</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">token</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> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>completion</em> - </code> - </td> - <td> - <div> - <p>The completion block that will be called after logout has completed.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - </ul> - </div> - <div class="task-group"> - <div class="task-name-container"> - <a name="/Generic%20Request%20Methods"></a> - <a name="//apple_ref/swift/Section/Generic Request Methods" class="dashAnchor"></a> - <a href="#/Generic%20Request%20Methods"> - <h3 class="section-name">Generic Request Methods</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/sendRequest(_:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_">sendRequest(_:completion:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Starts the <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> sending process.</p> - -<div class="aside aside-note"> - <p class="aside-title">Note</p> - <p>This method should only be used when you construct your own <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> objects.</p> - -</div> - - </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">sendRequest</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span><span class="kt">UsergridRequest</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>request</em> - </code> - </td> - <td> - <div> - <p>The <code>UsergridRequest</code> object to send.</p> - - </div> - </td> - </tr> - <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> - </ul> - </div> - <div class="task-group"> - <div class="task-name-container"> - <a name="/GET"></a> - <a name="//apple_ref/swift/Section/GET" class="dashAnchor"></a> - <a href="#/GET"> - <h3 class="section-name">GET</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK14UsergridClient3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/GET(_:uuidOrName:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK14UsergridClient3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_">GET(_:uuidOrName:completion:)</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 single <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> of a given type with a specific UUID/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="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">uuidOrName</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
<TRUNCATED>
