http://git-wip-us.apache.org/repos/asf/usergrid/blob/c733f01f/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser.html index 5526b15..aa93547 100644 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser.html +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser.html @@ -7,13 +7,14 @@ <meta charset='utf-8'> <script src="../js/jquery.min.js" defer></script> <script src="../js/jazzy.js" defer></script> + </head> <body> <a name="//apple_ref/swift/Class/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> + <p><a href="../index.html"> Docs</a> (100% documented)</p> </div> </header> <div class="content-wrapper"> @@ -27,7 +28,7 @@ <nav class="sidebar"> <ul class="nav-groups"> <li class="nav-group-name"> - <a href="../Classes.html">Classes</a> + <a href="../Classes.html">Classes</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="../Classes/Usergrid.html">Usergrid</a> @@ -39,6 +40,9 @@ <a href="../Classes/UsergridAsset.html">UsergridAsset</a> </li> <li class="nav-group-task"> + <a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a> + </li> + <li class="nav-group-task"> <a href="../Classes/UsergridAuth.html">UsergridAuth</a> </li> <li class="nav-group-task"> @@ -60,9 +64,15 @@ <a href="../Classes/UsergridQuery.html">UsergridQuery</a> </li> <li class="nav-group-task"> + <a href="../Classes/UsergridRequest.html">UsergridRequest</a> + </li> + <li class="nav-group-task"> <a href="../Classes/UsergridResponse.html">UsergridResponse</a> </li> <li class="nav-group-task"> + <a href="../Classes/UsergridResponseError.html">UsergridResponseError</a> + </li> + <li class="nav-group-task"> <a href="../Classes/UsergridUser.html">UsergridUser</a> </li> <li class="nav-group-task"> @@ -71,10 +81,18 @@ </ul> </li> <li class="nav-group-name"> - <a href="../Enums.html">Enums</a> + <a href="../Global Variables.html">Global Variables</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../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/UsergridAuthFallback.html">UsergridAuthFallback</a> + <a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a> </li> <li class="nav-group-task"> <a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a> @@ -86,6 +104,9 @@ <a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a> </li> <li class="nav-group-task"> + <a href="../Enums/UsergridHttpMethod.html">UsergridHttpMethod</a> + </li> + <li class="nav-group-task"> <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a> </li> <li class="nav-group-task"> @@ -100,7 +121,15 @@ </ul> </li> <li class="nav-group-name"> - <a href="../Typealiases.html">Typealiases</a> + <a href="../Extensions.html">Extensions</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Extensions/NSDate.html">NSDate</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Typealiases.html">Typealiases</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="../Typealiases.html#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a> @@ -120,6 +149,12 @@ <li class="nav-group-task"> <a href="../Typealiases.html#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a> </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a> + </li> </ul> </li> </ul> @@ -129,12 +164,12 @@ <section class="section"> <h1>UsergridUser</h1> <div class="declaration"> - <div class="Swift"> + <div class="language"> <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">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> + <p><code>UsergridUser</code> is a special subclass of <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> that supports functions and properties unique to users.</p> </section> <section class="section task-group-section"> @@ -143,9 +178,9 @@ <li class="item"> <div> <code> - <a name="/s:sC11UsergridSDK12UsergridUser9subscriptFSSGSqPSs9AnyObject__"></a> + <a name="/s:iC11UsergridSDK12UsergridUser9subscriptFSSGSqPs9AnyObject__"></a> <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:sC11UsergridSDK12UsergridUser9subscriptFSSGSqPSs9AnyObject__">subscript(_:)</a> + <a class="token" href="#/s:iC11UsergridSDK12UsergridUser9subscriptFSSGSqPs9AnyObject__">subscript(_:)</a> </code> </div> <div class="height-container"> @@ -153,13 +188,17 @@ <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Subscript for the <code>UsergridUser</code> class.</p> + <p>Subscript for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> class.</p> -<ul> -<li><p>Example usage: +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>When setting a properties value must be a valid JSON object.</p> + +</div> + +<p><li><p>Example usage: “` -let someName = usergridUser[<q>name</q>]</p></li> -</ul> +let someName = usergridUser[<q>name</q>]</p></li></p> <p>usergridUser[<q>name</q>] = someName ”`</p> @@ -167,7 +206,7 @@ let someName = usergridUser[<q>name</q>]</p></li> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="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">-></span> <span class="kt">AnyObject</span><span class="p">?</span></code></pre> @@ -179,13 +218,13 @@ let someName = usergridUser[<q>name</q>]</p></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> + <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> @@ -200,12 +239,12 @@ let someName = usergridUser[<q>name</q>]</p></li> <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>The <code>UsergridUserAuth</code> object if this user was authenticated.</p> + <p>The <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> object if this user was authenticated.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">auth</span><span class="p">:</span> <span class="kt">UsergridUserAuth</span><span class="p">?</span></code></pre> @@ -227,14 +266,14 @@ let someName = usergridUser[<q>name</q>]</p></li> <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>Property helper method for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties4NameFMS0_S0_">UsergridUserProperties.Name</a></code>.</p> -<p>Unlike <code>UsergridEntity</code> objects, <code>UsergridUser</code>’s can change their name property which is why we provide a getter here.</p> +<p>Unlike <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> objects, <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>’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"> + <div class="language"> <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> @@ -256,12 +295,12 @@ let someName = usergridUser[<q>name</q>]</p></li> <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> + <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties8UsernameFMS0_S0_">UsergridUserProperties.Username</a></code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">username</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> @@ -283,12 +322,12 @@ let someName = usergridUser[<q>name</q>]</p></li> <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> + <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties8PasswordFMS0_S0_">UsergridUserProperties.Password</a></code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> @@ -310,12 +349,12 @@ let someName = usergridUser[<q>name</q>]</p></li> <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> + <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties5EmailFMS0_S0_">UsergridUserProperties.Email</a></code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">email</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> @@ -337,12 +376,12 @@ let someName = usergridUser[<q>name</q>]</p></li> <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> + <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties3AgeFMS0_S0_">UsergridUserProperties.Age</a></code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">age</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="p">?</span></code></pre> @@ -354,6 +393,33 @@ let someName = usergridUser[<q>name</q>]</p></li> <li class="item"> <div> <code> + <a name="/s:vC11UsergridSDK12UsergridUser15usernameOrEmailGSqSS_"></a> + <a name="//apple_ref/swift/Property/usernameOrEmail" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK12UsergridUser15usernameOrEmailGSqSS_">usernameOrEmail</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 to get the username or email of the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">usernameOrEmail</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">username</span> <span class="p">??</span> <span class="k">self</span><span class="o">.</span><span class="n">email</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> @@ -364,14 +430,14 @@ let someName = usergridUser[<q>name</q>]</p></li> <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>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties9ActivatedFMS0_S0_">UsergridUserProperties.Activated</a></code>.</p> <p>Indicates whether the user account has been activated or not.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">activated</span><span class="p">:</span> <span class="kt">Bool</span></code></pre> @@ -393,12 +459,12 @@ let someName = usergridUser[<q>name</q>]</p></li> <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> + <p>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties8DisabledFMS0_S0_">UsergridUserProperties.Disabled</a></code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">disabled</span><span class="p">:</span> <span class="kt">Bool</span></code></pre> @@ -420,14 +486,14 @@ let someName = usergridUser[<q>name</q>]</p></li> <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>Property getter and setter helpers for the <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects <code><a href="../Enums/UsergridUserProperties.html#/s:FO11UsergridSDK22UsergridUserProperties7PictureFMS0_S0_">UsergridUserProperties.Picture</a></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"> + <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">picture</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre> @@ -454,7 +520,7 @@ let someName = usergridUser[<q>name</q>]</p></li> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">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> @@ -466,20 +532,20 @@ let someName = usergridUser[<q>name</q>]</p></li> </ul> </div> <div class="task-group"> - <div class="task-name-container"> - <a name="/Initialization"></a> - <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a> - <a href="#/Initialization"> - <h3 class="section-name">Initialization</h3> - </a> - </div> + <div class="task-name-container"> + <a name="/Initialization"></a> + <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a> + <a href="#/Initialization"> + <h3 class="section-name">Initialization</h3> + </a> + </div> <ul> <li class="item"> <div> <code> - <a name="/s:FC11UsergridSDK12UsergridUsercFMS0_FT4nameGSqSS__S0_"></a> + <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameGSqSS__S0_"></a> <a name="//apple_ref/swift/Method/init(name:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFMS0_FT4nameGSqSS__S0_">init(name:)</a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameGSqSS__S0_">init(name:)</a> </code> </div> <div class="height-container"> @@ -487,12 +553,12 @@ let someName = usergridUser[<q>name</q>]</p></li> <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Designated initializer for <code>UsergridUser</code> objects.</p> + <p>Designated initializer for <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">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> @@ -520,7 +586,7 @@ let someName = usergridUser[<q>name</q>]</p></li> </div> <div> <h4>Return Value</h4> - <p>A new instance of <code>UsergridUser</code>.</p> + <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p> </div> </section> @@ -529,9 +595,9 @@ let someName = usergridUser[<q>name</q>]</p></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> + <a name="/s:FC11UsergridSDK12UsergridUsercFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a> + <a name="//apple_ref/swift/Method/init(type:name:propertyDict:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4typeSS4nameGSqSS_12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_">init(type:name:propertyDict:)</a> </code> </div> <div class="height-container"> @@ -539,14 +605,14 @@ let someName = usergridUser[<q>name</q>]</p></li> <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Designated initializer for <code>UsergridUser</code> objects.</p> + <p>The required public initializer for <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> subclasses.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">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> + <pre class="highlight"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</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">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="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?)</span></code></pre> </div> </div> @@ -557,12 +623,25 @@ let someName = usergridUser[<q>name</q>]</p></li> <tr> <td> <code> + <em>type</em> + </code> + </td> + <td> + <div> + <p>The type associated with the <code>UsergridEntity</code> object.</p> + + </div> + </td> + </tr> + <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> + <p>The optional name associated with the <code>UsergridEntity</code> object.</p> </div> </td> @@ -585,29 +664,18 @@ let someName = usergridUser[<q>name</q>]</p></li> </div> <div> <h4>Return Value</h4> - <p>A new instance of <code>UsergridUser</code>.</p> + <p>A new <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</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> + <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameSS12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_"></a> + <a name="//apple_ref/swift/Method/init(name:propertyDict:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameSS12propertyDictGSqGVs10DictionarySSPs9AnyObject____S0_">init(name:propertyDict:)</a> </code> </div> <div class="height-container"> @@ -615,14 +683,14 @@ let someName = usergridUser[<q>name</q>]</p></li> <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> + <p>Designated initializer for <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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> + <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> @@ -633,12 +701,25 @@ let someName = usergridUser[<q>name</q>]</p></li> <tr> <td> <code> - <em>completion</em> + <em>name</em> </code> </td> <td> <div> - <p>The optional completion block.</p> + <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> @@ -646,15 +727,20 @@ let someName = usergridUser[<q>name</q>]</p></li> </tbody> </table> </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p> + + </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> + <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameSS5emailSS8passwordGSqSS__S0_"></a> + <a name="//apple_ref/swift/Method/init(name:email:password:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameSS5emailSS8passwordGSqSS__S0_">init(name:email:password:)</a> </code> </div> <div class="height-container"> @@ -662,14 +748,14 @@ let someName = usergridUser[<q>name</q>]</p></li> <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> + <p>Convenience initializer for <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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> + <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">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">email</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="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> </div> </div> @@ -680,12 +766,12 @@ let someName = usergridUser[<q>name</q>]</p></li> <tr> <td> <code> - <em>client</em> + <em>name</em> </code> </td> <td> <div> - <p>The client to use for creation.</p> + <p>The name of the user. Note this is different from the <code>username</code> property.</p> </div> </td> @@ -693,12 +779,25 @@ let someName = usergridUser[<q>name</q>]</p></li> <tr> <td> <code> - <em>completion</em> + <em>email</em> </code> </td> <td> <div> - <p>The optional completion block.</p> + <p>The user’s email.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>password</em> + </code> + </td> + <td> + <div> + <p>The optional user’s password.</p> </div> </td> @@ -706,15 +805,20 @@ let someName = usergridUser[<q>name</q>]</p></li> </tbody> </table> </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p> + + </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> + <a name="/s:FC11UsergridSDK12UsergridUsercFT5emailSS8passwordGSqSS__S0_"></a> + <a name="//apple_ref/swift/Method/init(email:password:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT5emailSS8passwordGSqSS__S0_">init(email:password:)</a> </code> </div> <div class="height-container"> @@ -722,16 +826,14 @@ let someName = usergridUser[<q>name</q>]</p></li> <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> + <p>Convenience initializer for <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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> + <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">email</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="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> </div> </div> @@ -742,12 +844,12 @@ let someName = usergridUser[<q>name</q>]</p></li> <tr> <td> <code> - <em>username</em> + <em>email</em> </code> </td> <td> <div> - <p>The username.</p> + <p>The user’s email.</p> </div> </td> @@ -760,20 +862,7 @@ let someName = usergridUser[<q>name</q>]</p></li> </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> + <p>The optional user’s password.</p> </div> </td> @@ -781,15 +870,20 @@ let someName = usergridUser[<q>name</q>]</p></li> </tbody> </table> </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p> + + </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> + <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameSS8usernameSS8passwordGSqSS__S0_"></a> + <a name="//apple_ref/swift/Method/init(name:username:password:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameSS8usernameSS8passwordGSqSS__S0_">init(name:username:password:)</a> </code> </div> <div class="height-container"> @@ -797,16 +891,14 @@ let someName = usergridUser[<q>name</q>]</p></li> <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> + <p>Convenience initializer for <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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> + <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">name</span><span class="p">:</span><span class="kt">String</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="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> </div> </div> @@ -817,12 +909,12 @@ let someName = usergridUser[<q>name</q>]</p></li> <tr> <td> <code> - <em>client</em> + <em>name</em> </code> </td> <td> <div> - <p>The client to use for login.</p> + <p>The name of the user. Note this is different from the <code>username</code> property.</p> </div> </td> @@ -835,7 +927,7 @@ let someName = usergridUser[<q>name</q>]</p></li> </td> <td> <div> - <p>The username.</p> + <p>The username of the user.</p> </div> </td> @@ -848,20 +940,72 @@ let someName = usergridUser[<q>name</q>]</p></li> </td> <td> <div> - <p>The password.</p> + <p>The optional user’s password.</p> </div> </td> </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK12UsergridUsercFT8usernameSS8passwordGSqSS__S0_"></a> + <a name="//apple_ref/swift/Method/init(username:password:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT8usernameSS8passwordGSqSS__S0_">init(username:password:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Convenience initializer for <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</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="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> + <em>username</em> </code> </td> <td> <div> - <p>The optional completion block.</p> + <p>The username of the user.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>password</em> + </code> + </td> + <td> + <div> + <p>The optional user’s password.</p> </div> </td> @@ -869,15 +1013,20 @@ let someName = usergridUser[<q>name</q>]</p></li> </tbody> </table> </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code>.</p> + + </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> + <a name="/s:FC11UsergridSDK12UsergridUsercFT4nameGSqSS_5emailGSqSS_8usernameGSqSS_8passwordGSqSS__S0_"></a> + <a name="//apple_ref/swift/Method/init(name:email:username:password:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT4nameGSqSS_5emailGSqSS_8usernameGSqSS_8passwordGSqSS__S0_">init(name:email:username:password:)</a> </code> </div> <div class="height-container"> @@ -885,14 +1034,14 @@ let someName = usergridUser[<q>name</q>]</p></li> <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Invalidates the user token locally and remotely.</p> + <p>Convenience initializer for <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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> + <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">name</span><span class="p">:</span><span class="kt">String</span><span class="p">?,</span> <span class="nv">email</span><span class="p">:</span><span class="kt">String</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="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> </div> </div> @@ -903,12 +1052,51 @@ let someName = usergridUser[<q>name</q>]</p></li> <tr> <td> <code> - <em>completion</em> + <em>name</em> </code> </td> <td> <div> - <p>The optional completion block.</p> + <p>The optional name of the user. Note this is different from the <code>username</code> property.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>email</em> + </code> + </td> + <td> + <div> + <p>The optional user’s email.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>username</em> + </code> + </td> + <td> + <div> + <p>The optional username of the user.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>password</em> + </code> + </td> + <td> + <div> + <p>The optional user’s password.</p> </div> </td> @@ -916,15 +1104,31 @@ let someName = usergridUser[<q>name</q>]</p></li> </tbody> </table> </div> + <div> + <h4>Return Value</h4> + <p>A new instance of <code><a href="../Classes/UsergridUser.html">UsergridUser</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: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> + <a name="/s:FC11UsergridSDK12UsergridUsercFT5coderCSo7NSCoder_GSqS0__"></a> + <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUsercFT5coderCSo7NSCoder_GSqS0__">init(coder:)</a> </code> </div> <div class="height-container"> @@ -932,14 +1136,14 @@ let someName = usergridUser[<q>name</q>]</p></li> <section class="section"> <div class="pointer"></div> <div class="abstract"> - <p>Invalidates the user token locally and remotely.</p> + <p>NSCoding protocol initializer.</p> </div> <div class="declaration"> <h4>Declaration</h4> - <div class="Swift"> + <div class="language"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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> + <pre class="highlight"><code><span class="kd">required</span> <span class="kd">public</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> @@ -950,12 +1154,1248 @@ let someName = usergridUser[<q>name</q>]</p></li> <tr> <td> <code> - <em>client</em> + <em>aDecoder</em> </code> </td> <td> <div> - <p>The client to use for logout.</p> + <p>The decoder.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK12UsergridUser15encodeWithCoderFCSo7NSCoderT_"></a> + <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUser15encodeWithCoderFCSo7NSCoderT_">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="k">override</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="/Class%20Methods"></a> + <a name="//apple_ref/swift/Section/Class Methods" class="dashAnchor"></a> + <a href="#/Class%20Methods"> + <h3 class="section-name">Class Methods</h3> + </a> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_"></a> + <a name="//apple_ref/swift/Method/checkAvailable(_:username:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_">checkAvailable(_:username:completion:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Checks the given email and/or username availablity for new <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects 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">checkAvailable</span><span class="p">(</span><span class="nv">email</span><span class="p">:</span><span class="kt">String</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">completion</span><span class="p">:</span><span class="kt">UsergridUserAvailabilityCompletion</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>email</em> + </code> + </td> + <td> + <div> + <p>The optional email address.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>username</em> + </code> + </td> + <td> + <div> + <p>The optional username.</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:ZFC11UsergridSDK12UsergridUser14checkAvailableFTCS_14UsergridClient5emailGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_"></a> + <a name="//apple_ref/swift/Method/checkAvailable(_:email:username:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:ZFC11UsergridSDK12UsergridUser14checkAvailableFTCS_14UsergridClient5emailGSqSS_8usernameGSqSS_10completionFT5errorGSqCS_21UsergridResponseError_9availableSb_T__T_">checkAvailable(_:email:username:completion:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Checks the given email and/or username availablity for new <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> objects using with the given <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">checkAvailable</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">email</span><span class="p">:</span><span class="kt">String</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">completion</span><span class="p">:</span><span class="kt">UsergridUserAvailabilityCompletion</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 checking availability.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>email</em> + </code> + </td> + <td> + <div> + <p>The optional email address.</p> + + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>username</em> + </code> + </td> + <td> + <div> + <p>The optional username.</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="/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:FC11UsergridSDK12UsergridUser6createFTGSqFT8responseCS_16UsergridResponse_T___T_"></a> + <a name="//apple_ref/swift/Method/create(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUser6createFTGSqFT8responseCS_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><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">create</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 optional completion block.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK12UsergridUser6createFTCS_14UsergridClient10completionGSqFT8responseCS_16UsergridResponse_T___T_"></a> + <a name="//apple_ref/swift/Method/create(_:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUser6createFTCS_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><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>client</em> + </code> + </td> + <td> + <div> + <p>The 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:FC11UsergridSDK12UsergridUser5loginFTSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__T___T_"></a> + <a name="//apple_ref/swift/Method/login(_:password:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUser5loginFTSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__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><a href="../Classes/UsergridClient.html">UsergridClient</a></code>.</p> + +<p>While functionally similar to <code>UsergridClient.authenticateUser(auth)</code>, this method does not automatically assign this user to <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>:</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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> <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>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:FC11UsergridSDK12UsergridUser5loginFTCS_14UsergridClient8usernameSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__T___T_"></a> + <a name="//apple_ref/swift/Method/login(_:username:password:completion:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK12UsergridUser5loginFTCS_14UsergridClient8usernameSS8passwordSS10completionGSqFT4authGSqCS_16UsergridUserAuth_4userGSqS0__5errorGSqCS_21UsergridResponseError__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.</p> + +<p>While functionally similar to <code>UsergridClient.authenticateUser(auth)</code>, this method does not automatically assign this user to <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>:</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>client</em> + </code> + </td> +
<TRUNCATED>
