Google Git
Sign in
apache / usergrid / 1684a64e408212be47a653e8d64ded06573a3312 / . / sdks / swift / docs / docsets / .docset / Contents / Resources / Documents / Classes / UsergridUser.html
blob: 5526b15db82143502b3988a4d269059701e4dd52 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<title>UsergridUser 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/UsergridUser" class="dashAnchor"></a>
<a title="UsergridUser Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (97% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<img id="carat" src="../img/carat.png" />
UsergridUser 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/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/UsergridResponse.html">UsergridResponse</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="../Enums.html">Enums</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/UsergridAuthFallback.html">UsergridAuthFallback</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/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="../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>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>UsergridUser</h1>
<div class="declaration">
<div class="Swift">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridUser</span> <span class="p">:</span> <span class="kt">UsergridEntity</span></code></pre>
</div>
</div>
<p><code>UsergridUser</code> is a special subclass of <code>UsergridEntity</code> that supports functions and properties unique to users.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:sC11UsergridSDK12UsergridUser9subscriptFSSGSqPSs9AnyObject__"></a>
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:sC11UsergridSDK12UsergridUser9subscriptFSSGSqPSs9AnyObject__">subscript(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Subscript for the <code>UsergridUser</code> class.</p>
<ul>
<li><p>Example usage:
&ldquo;`
let someName = usergridUser[<q>name</q>]</p></li>
</ul>
<p>usergridUser[<q>name</q>] = someName
&rdquo;`</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">override</span> <span class="kd">public</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">propertyName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">AnyObject</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/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:vC11UsergridSDK12UsergridUser4authGSqCS_16UsergridUserAuth_"></a>
<a name="//apple_ref/swift/Property/auth" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK12UsergridUser4authGSqCS_16UsergridUserAuth_">auth</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The <code>UsergridUserAuth</code> object if this user was authenticated.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">auth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK12UsergridUser4nameGSqSS_"></a>
<a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK12UsergridUser4nameGSqSS_">name</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property helper method for the <code>UsergridUser</code> objects <code>UsergridUserProperties.Name</code>.</p>
<p>Unlike <code>UsergridEntity</code> objects, <code>UsergridUser</code>&rsquo;s can change their name property which is why we provide a getter here.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">override</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK12UsergridUser8usernameGSqSS_"></a>
<a name="//apple_ref/swift/Property/username" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK12UsergridUser8usernameGSqSS_">username</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property getter and setter helpers for the <code>UsergridUser</code> objects <code>UsergridUserProperties.Username</code>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">username</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK12UsergridUser8passwordGSqSS_"></a>
<a name="//apple_ref/swift/Property/password" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK12UsergridUser8passwordGSqSS_">password</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property getter and setter helpers for the <code>UsergridUser</code> objects <code>UsergridUserProperties.Password</code>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK12UsergridUser5emailGSqSS_"></a>
<a name="//apple_ref/swift/Property/email" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK12UsergridUser5emailGSqSS_">email</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property getter and setter helpers for the <code>UsergridUser</code> objects <code>UsergridUserProperties.Email</code>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">email</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK12UsergridUser3ageGSqCSo8NSNumber_"></a>
<a name="//apple_ref/swift/Property/age" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK12UsergridUser3ageGSqCSo8NSNumber_">age</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property getter and setter helpers for the <code>UsergridUser</code> objects <code>UsergridUserProperties.Age</code>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">age</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK12UsergridUser9activatedSb"></a>
<a name="//apple_ref/swift/Property/activated" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK12UsergridUser9activatedSb">activated</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property getter and setter helpers for the <code>UsergridUser</code> objects <code>UsergridUserProperties.Activated</code>.</p>
<p>Indicates whether the user account has been activated or not.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">activated</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:vC11UsergridSDK12UsergridUser8disabledSb"></a>
<a name="//apple_ref/swift/Property/disabled" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK12UsergridUser8disabledSb">disabled</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property getter and setter helpers for the <code>UsergridUser</code> objects <code>UsergridUserProperties.Disabled</code>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">disabled</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:vC11UsergridSDK12UsergridUser7pictureGSqSS_"></a>
<a name="//apple_ref/swift/Property/picture" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK12UsergridUser7pictureGSqSS_">picture</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property getter and setter helpers for the <code>UsergridUser</code> objects <code>UsergridUserProperties.Picture</code>.</p>
<p>URL path to user’s profile picture. Defaults to Gravatar for email address.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">picture</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC11UsergridSDK12UsergridUser14uuidOrUsernameGSqSS_"></a>
<a name="//apple_ref/swift/Property/uuidOrUsername" class="dashAnchor"></a>
<a class="token" href="#/s:vC11UsergridSDK12UsergridUser14uuidOrUsernameGSqSS_">uuidOrUsername</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The UUID or username property value if found.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">uuidOrUsername</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">uuid</span> <span class="p">??</span> <span class="k">self</span><span class="o">.</span><span class="n">username</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Initialization"></a>
<a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
<a href="#/Initialization">
<h3 class="section-name">Initialization</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK12UsergridUsercFMS0_FT4nameGSqSS__S0_"></a>
<a name="//apple_ref/swift/Method/init(name:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFMS0_FT4nameGSqSS__S0_">init(name:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Designated initializer for <code>UsergridUser</code> objects.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<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">name</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>name</em>
</code>
</td>
<td>
<div>
<p>The name of the user. Note this is different from the <code>username</code> property.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A new instance of <code>UsergridUser</code>.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK12UsergridUsercFMS0_FT4nameSS12propertyDictGSqGVSs10DictionarySSPSs9AnyObject____S0_"></a>
<a name="//apple_ref/swift/Method/init(name:propertyDict:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFMS0_FT4nameSS12propertyDictGSqGVSs10DictionarySSPSs9AnyObject____S0_">init(name:propertyDict:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Designated initializer for <code>UsergridUser</code> objects.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<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">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span><span class="nv">propertyDict</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>name</em>
</code>
</td>
<td>
<div>
<p>The name of the user. Note this is different from the <code>username</code> property.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>propertyDict</em>
</code>
</td>
<td>
<div>
<p>The optional property dictionary that the <code>UsergridEntity</code> object will start out with.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A new instance of <code>UsergridUser</code>.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Instance%20Methods"></a>
<a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
<a href="#/Instance%20Methods">
<h3 class="section-name">Instance Methods</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:FC11UsergridSDK12UsergridUser6createFS0_FGSqFT8responseCS_16UsergridResponse_T__T_"></a>
<a name="//apple_ref/swift/Method/create(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK12UsergridUser6createFS0_FGSqFT8responseCS_16UsergridResponse_T__T_">create(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates the user object in Usergrid if the user does not already exist with the shared instance of <code>UsergridClient</code>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">create</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<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:FC11UsergridSDK12UsergridUser6createFS0_FTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/create(_:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK12UsergridUser6createFS0_FTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">create(_:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates the user object in Usergrid if the user does not already exist with the given <code>UsergridClient</code>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">create</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>client</em>
</code>
</td>
<td>
<div>
<p>The client to use for creation.</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:FC11UsergridSDK12UsergridUser5loginFS0_FTSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqSS__T___T_"></a>
<a name="//apple_ref/swift/Method/login(_:password:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK12UsergridUser5loginFS0_FTSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqSS__T___T_">login(_:password: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 the specified user using the provided username and password with the shared instance of <code>UsergridClient</code>.</p>
<p>While functionally similar to <code>UsergridClient.authenticateUser(auth)</code>, this method does not automatically assign this user to <code>UsergridClient.currentUser</code>:</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">login</span><span class="p">(</span><span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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">UsergridUserAuthCompletionBlock</span><span class="p">?)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>username</em>
</code>
</td>
<td>
<div>
<p>The username.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>password</em>
</code>
</td>
<td>
<div>
<p>The 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:FC11UsergridSDK12UsergridUser5loginFS0_FTCS_14UsergridClient8usernameSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqSS__T___T_"></a>
<a name="//apple_ref/swift/Method/login(_:username:password:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK12UsergridUser5loginFS0_FTCS_14UsergridClient8usernameSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqSS__T___T_">login(_:username:password: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 the specified user using the provided username and password with the shared instance of <code>UsergridClient</code>.</p>
<p>While functionally similar to <code>UsergridClient.authenticateUser(auth)</code>, this method does not automatically assign this user to <code>UsergridClient.currentUser</code>:</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">login</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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">UsergridUserAuthCompletionBlock</span><span class="p">?)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>client</em>
</code>
</td>
<td>
<div>
<p>The client to use for login.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>username</em>
</code>
</td>
<td>
<div>
<p>The username.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>password</em>
</code>
</td>
<td>
<div>
<p>The 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:FC11UsergridSDK12UsergridUser6logoutFS0_FGSqFT8responseCS_16UsergridResponse_T__T_"></a>
<a name="//apple_ref/swift/Method/logout(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK12UsergridUser6logoutFS0_FGSqFT8responseCS_16UsergridResponse_T__T_">logout(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Invalidates the user token locally and remotely.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">logout</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<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:FC11UsergridSDK12UsergridUser6logoutFS0_FTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a>
<a name="//apple_ref/swift/Method/logout(_:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC11UsergridSDK12UsergridUser6logoutFS0_FTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_">logout(_:completion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Invalidates the user token locally and remotely.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">logout</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt">UsergridClient</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span><span class="kt">UsergridResponseCompletion</span><span class="p">?)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>client</em>
</code>
</td>
<td>
<div>
<p>The client to use for logout.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>The optional completion block.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-12-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>