http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html deleted file mode 100644 index 61bf26f..0000000 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/Usergrid.html +++ /dev/null @@ -1,3798 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <title>Usergrid 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/Usergrid" class="dashAnchor"></a> - <a title="Usergrid 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" /> - Usergrid 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>Usergrid</h1> - <div class="declaration"> - <div class="language"> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Usergrid</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre> - - </div> - </div> - <p>The <code>Usergrid</code> class acts as a static shared instance manager for the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> class.</p> - -<p>The methods and variables in this class are all static and therefore you will never need or want to initialize an instance of the <code>Usergrid</code> class.</p> - -<p>Use of this class depends on initialization of the shared instance of the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> object. Because of this, before using any of the static methods -provided you will need to call one of the shared instance initialization methods. Failure to do so will result in failure from all methods.</p> - - </section> - <section class="section task-group-section"> - <div class="task-group"> - <div class="task-name-container"> - <a name="/Static%20Variables"></a> - <a name="//apple_ref/swift/Section/Static Variables" class="dashAnchor"></a> - <a href="#/Static%20Variables"> - <h3 class="section-name">Static Variables</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:ZvC11UsergridSDK8Usergrid13isInitializedSb"></a> - <a name="//apple_ref/swift/Variable/isInitialized" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid13isInitializedSb">isInitialized</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Used to determine if the shared instance of the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> has been initialized.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">isInitialized</span> <span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">_sharedClient</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">}</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient"></a> - <a name="//apple_ref/swift/Variable/sharedInstance" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">sharedInstance</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>A shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, used by the <code><a href="../Classes/Usergrid.html">Usergrid</a></code> static methods and acts as the default <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> -within the UsergridSDK library.</p> - -<div class="aside aside-warning"> - <p class="aside-title">Warning</p> - You must call one of the <code>Usergrid.initSharedInstance</code> methods before this or any other <code><a href="../Classes/Usergrid.html">Usergrid</a></code> static methods are valid. - -</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">static</span> <span class="k">var</span> <span class="nv">sharedInstance</span> <span class="p">:</span> <span class="kt">UsergridClient</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZvC11UsergridSDK8Usergrid5appIdSS"></a> - <a name="//apple_ref/swift/Variable/appId" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid5appIdSS">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 the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">appId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</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:ZvC11UsergridSDK8Usergrid5orgIdSS"></a> - <a name="//apple_ref/swift/Variable/orgId" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid5orgIdSS">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 of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">orgId</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</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:ZvC11UsergridSDK8Usergrid7baseUrlSS"></a> - <a name="//apple_ref/swift/Variable/baseUrl" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid7baseUrlSS">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 of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">baseUrl</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</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:ZvC11UsergridSDK8Usergrid12clientAppURLSS"></a> - <a name="//apple_ref/swift/Variable/clientAppURL" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid12clientAppURLSS">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 baseUrl, orgId, and appId of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">clientAppURL</span> <span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">clientAppURL</span> <span class="p">}</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_"></a> - <a name="//apple_ref/swift/Variable/currentUser" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_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> of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">currentUser</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="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">currentUser</span> <span class="p">}</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZvC11UsergridSDK8Usergrid28persistCurrentUserInKeychainSb"></a> - <a name="//apple_ref/swift/Variable/persistCurrentUserInKeychain" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid28persistCurrentUserInKeychainSb">persistCurrentUserInKeychain</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Whether or not the current user will be saved and restored from the keychain using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">persistCurrentUserInKeychain</span><span class="p">:</span> <span class="kt">Bool</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZvC11UsergridSDK8Usergrid8userAuthGSqCS_16UsergridUserAuth_"></a> - <a name="//apple_ref/swift/Variable/userAuth" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid8userAuthGSqCS_16UsergridUserAuth_">userAuth</a> - </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/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid11currentUserGSqCS_12UsergridUser_">currentUser</a></code> property of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">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="kt">Usergrid</span><span class="o">.</span><span class="n">sharedInstance</span><span class="o">.</span><span class="n">userAuth</span> <span class="p">}</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZvC11UsergridSDK8Usergrid7appAuthGSqCS_15UsergridAppAuth_"></a> - <a name="//apple_ref/swift/Variable/appAuth" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid7appAuthGSqCS_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 of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">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:ZvC11UsergridSDK8Usergrid8authModeOS_16UsergridAuthMode"></a> - <a name="//apple_ref/swift/Variable/authMode" class="dashAnchor"></a> - <a class="token" href="#/s:ZvC11UsergridSDK8Usergrid8authModeOS_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 of the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>, if any.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">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:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS_CS_14UsergridClient"></a> - <a name="//apple_ref/swift/Method/initSharedInstance(orgId:appId:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS_CS_14UsergridClient">initSharedInstance(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 the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">orgId</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="o">-></span> <span class="kt">UsergridClient</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 shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS7baseUrlSS_CS_14UsergridClient"></a> - <a name="//apple_ref/swift/Method/initSharedInstance(orgId:appId:baseUrl:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT5orgIdSS5appIdSS7baseUrlSS_CS_14UsergridClient">initSharedInstance(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 the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">orgId</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> <span class="o">-></span> <span class="kt">UsergridClient</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 shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT13configurationCS_20UsergridClientConfig_CS_14UsergridClient"></a> - <a name="//apple_ref/swift/Method/initSharedInstance(configuration:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid18initSharedInstanceFT13configurationCS_20UsergridClientConfig_CS_14UsergridClient">initSharedInstance(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 the <code><a href="../Classes/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid14sharedInstanceCS_14UsergridClient">Usergrid.sharedInstance</a></code> of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">initSharedInstance</span><span class="p">(</span><span class="n">configuration</span> <span class="nv">configuration</span><span class="p">:</span> <span class="kt">UsergridClientConfig</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridClient</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 shared 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="/Push%20Notifications"></a> - <a name="//apple_ref/swift/Section/Push Notifications" class="dashAnchor"></a> - <a href="#/Push%20Notifications"> - <h3 class="section-name">Push Notifications</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/applyPushToken(_:notifierID:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCSo6NSData10notifierIDSS10completionGSqFT8responseCS_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 using the shared instance of <code>UsergridCient</code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="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:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCS_14UsergridDevice9pushTokenCSo6NSData10notifierIDSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/applyPushToken(_:pushToken:notifierID:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid14applyPushTokenFTCS_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 using the shared instance of <code>UsergridCient</code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="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"></a> - <a name="//apple_ref/swift/Section/Authorization" class="dashAnchor"></a> - <a href="#/Authorization"> - <h3 class="section-name">Authorization</h3> - </a> - </div> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:ZFC11UsergridSDK8Usergrid9usingAuthFCS_12UsergridAuthCS_14UsergridClient"></a> - <a name="//apple_ref/swift/Method/usingAuth(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid9usingAuthFCS_12UsergridAuthCS_14UsergridClient">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 shared <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’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">static</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="kt">UsergridClient</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>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code></p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZFC11UsergridSDK8Usergrid10usingTokenFSSCS_14UsergridClient"></a> - <a name="//apple_ref/swift/Method/usingToken(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid10usingTokenFSSCS_14UsergridClient">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 shared <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>’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">static</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="kt">UsergridClient</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>The shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code></p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZFC11UsergridSDK8Usergrid15authForRequestsFT_GSqCS_12UsergridAuth_"></a> - <a name="//apple_ref/swift/Method/authForRequests()" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authForRequestsFT_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 by the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</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/Usergrid.html#/s:ZvC11UsergridSDK8Usergrid8authModeOS_16UsergridAuthMode">authMode</a></code> is <code>.App</code>, and the <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> of the client is set and the token is valid it will return that.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">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:ZFC11UsergridSDK8Usergrid15authenticateAppFTGSqFT4authGSqCS_15UsergridAppAuth_5errorGSqCS_21UsergridResponseError__T___T_"></a> - <a name="//apple_ref/swift/Method/authenticateApp(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authenticateAppFTGSqFT4authGSqCS_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 within the shared instance of <code>UsergridCient</code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="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:ZFC11UsergridSDK8Usergrid15authenticateAppFTCS_15UsergridAppAuth10completionGSqFT4authGSqS1__5errorGSqCS_21UsergridResponseError__T___T_"></a> - <a name="//apple_ref/swift/Method/authenticateApp(_:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid15authenticateAppFTCS_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 using the shared instance of <code>UsergridCient</code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">authenticateApp</span><span class="p">(</span><span class="nv">auth</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:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_16UsergridUserAuth10completionGSqFT4authGSqS1__4userGSqCS_12UsergridUser_5errorGSqCS_21UsergridResponseError__T___T_"></a> - <a name="//apple_ref/swift/Method/authenticateUser(_:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_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 using the shared instance of <code>UsergridCient</code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">authenticateUser</span><span class="p">(</span><span class="nv">auth</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:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_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:ZFC11UsergridSDK8Usergrid16authenticateUserFTCS_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 using the shared instance of <code>UsergridCient</code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="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:ZFC11UsergridSDK8Usergrid13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_"></a> - <a name="//apple_ref/swift/Method/resetPassword(_:old:new:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid13resetPasswordFTCS_12UsergridUser3oldSS3newSS10completionGSqFT5errorGSqCS_21UsergridResponseError_10didSucceedSb_T___T_">resetPassword(_:old:new:completion:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Changes the given <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’s current password with the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">resetPassword</span><span class="p">(</span><span class="nv">user</span><span class="p">:</span> <span class="kt">UsergridUser</span><span class="p">,</span> <span class="nv">old</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">new</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridUserResetPasswordCompletion</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> - - </div> - </div> - <div> - <h4>Parameters</h4> - <table class="graybox"> - <tbody> - <tr> - <td> - <code> - <em>user</em> - </code> - </td> - <td> - <div> - <p>The user.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>old</em> - </code> - </td> - <td> - <div> - <p>The old password.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>new</em> - </code> - </td> - <td> - <div> - <p>The new password.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>completion</em> - </code> - </td> - <td> - <div> - <p>The optional completion block.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/logoutCurrentUser(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid17logoutCurrentUserFTGSqFT8responseCS_16UsergridResponse_T___T_">logoutCurrentUser(_:)</a> - </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 of the shared instance locally and remotely using the shared instance of <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">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:ZFC11UsergridSDK8Usergrid19logoutUserAllTokensFTSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/logoutUserAllTokens(_:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid19logoutUserAllTokensFTSS10completionGSqFT8responseCS_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 using the shared instance of <code>UsergridCient</code>.</p> - - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="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:ZFC11UsergridSDK8Usergrid10logoutUserFTSS5tokenGSqSS_10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/logoutUser(_:token:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid10logoutUserFTSS5tokenGSqSS_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">static</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:ZFC11UsergridSDK8Usergrid11sendRequestFTCS_15UsergridRequest10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/sendRequest(_:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid11sendRequestFTCS_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 using the shared instance of <code>UsergridCient</code>.</p> - -<div class="aside aside-note"> - <p class="aside-title">Note</p> - <p>This method should only be used when you construct your own `UsergridRequest 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">static</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:ZFC11UsergridSDK8Usergrid3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> - <a name="//apple_ref/swift/Method/GET(_:uuidOrName:completion:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFC11UsergridSDK8Usergrid3GETFTSS10uuidOrNameSS10completionGSqFT8responseCS_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 using the shared instance of <code>Use
<TRUNCATED>
