You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by mr...@apache.org on 2016/09/01 23:51:52 UTC
[02/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
deleted file mode 100644
index 9db7a66..0000000
--- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAuth.html
+++ /dev/null
@@ -1,550 +0,0 @@
-<!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">UsergridSDK Docs</a> (100% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html">UsergridSDK 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/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridAuth.html">UsergridAuth</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridClient.html">UsergridClient</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridDevice.html">UsergridDevice</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridEntity.html">UsergridEntity</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridQuery.html">UsergridQuery</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridRequest.html">UsergridRequest</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridResponse.html">UsergridResponse</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridResponseError.html">UsergridResponseError</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridUser.html">UsergridUser</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Global Variables.html">Global Variables</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Global Variables.html#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Enums.html">Enums</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Enums/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/UsergridHttpMethod.html">UsergridHttpMethod</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Typealiases.html">Typealiases</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Typealiases.html#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a>
- </li>
- <li class="nav-group-task">
- <a href="../Typealiases.html#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a>
- </li>
- <li class="nav-group-task">
- <a href="../Typealiases.html#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a>
- </li>
- <li class="nav-group-task">
- <a href="../Typealiases.html#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a>
- </li>
- <li class="nav-group-task">
- <a href="../Typealiases.html#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a>
- </li>
- <li class="nav-group-task">
- <a href="../Typealiases.html#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a>
- </li>
- <li class="nav-group-task">
- <a href="../Typealiases.html#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a>
- </li>
- <li class="nav-group-task">
- <a href="../Typealiases.html#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>UsergridAuth</h1>
- <div class="declaration">
- <div class="language">
- <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 <code>UsergridAuth</code> class functions to create and store authentication information used by Usergrid.</p>
-
-<p>The <code>UsergridAuth</code> sub classes, <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> and <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code>, provide different ways for authentication to be used in creating requests for access tokens through the SDK.</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><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> was authorized successfully.</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">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:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_"></a>
- <a name="//apple_ref/swift/Property/expiry" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_">expiry</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 at date, if this <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></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="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">expiry</span> <span class="p">:</span> <span class="kt">NSDate</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="language">
- <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:vC11UsergridSDK12UsergridAuth7isValidSb"></a>
- <a name="//apple_ref/swift/Property/isValid" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK12UsergridAuth7isValidSb">isValid</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="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isValid</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="language">
- <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>
- </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:FC11UsergridSDK12UsergridAuthcFMS0_FT11accessTokenSS6expiryGSqCSo6NSDate__S0_"></a>
- <a name="//apple_ref/swift/Method/init(accessToken:expiry:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuthcFMS0_FT11accessTokenSS6expiryGSqCSo6NSDate__S0_">init(accessToken:expiry:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Initializer for a base <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> object that just contains an <code><a href="../Classes/UsergridAuth.html#/s:vC11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</a></code> and an optional <code><a href="../Classes/UsergridAuth.html#/s:vC11UsergridSDK12UsergridAuth6expiryGSqCSo6NSDate_">expiry</a></code> date.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">accessToken</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">expiry</span><span class="p">:</span><span class="kt">NSDate</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>accessToken</em>
- </code>
- </td>
- <td>
- <div>
- <p>The access token.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>expiry</em>
- </code>
- </td>
- <td>
- <div>
- <p>The optional expiry date.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridAuth.html">UsergridAuth</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: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>NSCoding protocol initializer.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">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>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>aDecoder</em>
- </code>
- </td>
- <td>
- <div>
- <p>The decoder.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
-
- </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>NSCoding protocol encoder.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encodeWithCoder</span><span class="p">(</span><span class="nv">aCoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>aCoder</em>
- </code>
- </td>
- <td>
- <div>
- <p>The encoder.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/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:FC11UsergridSDK12UsergridAuth7destroyFS0_FT_T_"></a>
- <a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK12UsergridAuth7destroyFS0_FT_T_">destroy()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Destroys/removes the access token and expiry.</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">destroy</span><span class="p">()</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift" target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
- </section>
- </article>
- </div>
- </body>
-</div>
-</html>