| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <title>UsergridAuth 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/UsergridAuth" class="dashAnchor"></a> |
| <a title="UsergridAuth 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" /> |
| UsergridAuth 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>UsergridAuth</h1> |
| <div class="declaration"> |
| <div class="Swift"> |
| <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre> |
| |
| </div> |
| </div> |
| <p>The base class for <code>UsergridAppAuth</code> and <code>UsergridUserAuth</code> classes.</p> |
| |
| <p>This class should never be initialized on its own. The use of the <code>UsergridAppAuth</code> and <code>UsergridUserAuth</code> subclasses should be used.</p> |
| |
| </section> |
| <section class="section task-group-section"> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| <a name="/Instance%20Properties"></a> |
| <a name="//apple_ref/swift/Section/Instance Properties" class="dashAnchor"></a> |
| <a href="#/Instance%20Properties"> |
| <h3 class="section-name">Instance Properties</h3> |
| </a> |
| </div> |
| <ul> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_"></a> |
| <a name="//apple_ref/swift/Property/accessToken" class="dashAnchor"></a> |
| <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The access token, if this <code>UsergridAuth</code> was authorized successfully.</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">accessToken</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:vC11UsergridSDK12UsergridAuth9expiresInGSqSi_"></a> |
| <a name="//apple_ref/swift/Property/expiresIn" class="dashAnchor"></a> |
| <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth9expiresInGSqSi_">expiresIn</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The expires in time stamp, if this <code>UsergridAuth</code> was authorized successfully and their was a expires in time stamp within the token response.</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">expiresIn</span> <span class="p">:</span> <span class="kt">Int</span><span class="p">?</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:vC11UsergridSDK12UsergridAuth8hasTokenSb"></a> |
| <a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a> |
| <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth8hasTokenSb">hasToken</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>Determines if an access token exists.</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">hasToken</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">accessToken</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:vC11UsergridSDK12UsergridAuth12tokenIsValidSb"></a> |
| <a name="//apple_ref/swift/Property/tokenIsValid" class="dashAnchor"></a> |
| <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth12tokenIsValidSb">tokenIsValid</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>Determines if an access token exists and if the token is not expired.</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">tokenIsValid</span> <span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">hasToken</span> <span class="o">&&</span> <span class="o">!</span><span class="k">self</span><span class="o">.</span><span class="n">isExpired</span> <span class="p">}</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:vC11UsergridSDK12UsergridAuth9isExpiredSb"></a> |
| <a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a> |
| <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth9isExpiredSb">isExpired</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>Determines if the access token, if one exists, is expired.</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">isExpired</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:FC11UsergridSDK12UsergridAuthcFMS0_FT_S0_"></a> |
| <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a> |
| <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFMS0_FT_S0_">init()</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>Undocumented</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">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:FC11UsergridSDK12UsergridAuthcFMS0_FT5coderCSo7NSCoder_GSqS0__"></a> |
| <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a> |
| <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFMS0_FT5coderCSo7NSCoder_GSqS0__">init(coder:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>Undocumented</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">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:FC11UsergridSDK12UsergridAuth15encodeWithCoderFS0_FCSo7NSCoderT_"></a> |
| <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a> |
| <a class="token" href="#/s:FC11UsergridSDK12UsergridAuth15encodeWithCoderFS0_FCSo7NSCoderT_">encodeWithCoder(_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>Undocumented</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">class</span> <span class="kt">UsergridAuth</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </section> |
| </section> |
| <section id="footer"> |
| <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-12-18)</p> |
| <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p> |
| </section> |
| </article> |
| </div> |
| </body> |
| </div> |
| </html> |
