http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/8283a6dd/docs/docsets/.docset/Contents/Resources/Documents/Extensions/NSDate.html ---------------------------------------------------------------------- diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Extensions/NSDate.html b/docs/docsets/.docset/Contents/Resources/Documents/Extensions/NSDate.html new file mode 100644 index 0000000..e69c6e3 --- /dev/null +++ b/docs/docsets/.docset/Contents/Resources/Documents/Extensions/NSDate.html @@ -0,0 +1,448 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>NSDate Extension 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/Extension/NSDate" class="dashAnchor"></a> + <a title="NSDate Extension Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html"> Docs</a> (100% documented)</p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html"> Reference</a> + <img id="carat" src="../img/carat.png" /> + NSDate Extension Reference + </p> + </div> + <div class="content-wrapper"> + <nav class="sidebar"> + <ul class="nav-groups"> + <li class="nav-group-name"> + <a href="../Classes.html">Classes</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Classes/Usergrid.html">Usergrid</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridAsset.html">UsergridAsset</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridAuth.html">UsergridAuth</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridClient.html">UsergridClient</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridDevice.html">UsergridDevice</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridEntity.html">UsergridEntity</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridQuery.html">UsergridQuery</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridRequest.html">UsergridRequest</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridResponse.html">UsergridResponse</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridResponseError.html">UsergridResponseError</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridUser.html">UsergridUser</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Global Variables.html">Global Variables</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Global Variables.html#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Enums.html">Enums</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Enums/UsergridAuthMode.html">UsergridAuthMode</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridDirection.html">UsergridDirection</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridHttpMethod.html">UsergridHttpMethod</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Extensions.html">Extensions</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Extensions/NSDate.html">NSDate</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Typealiases.html">Typealiases</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a> + </li> + <li class="nav-group-task"> + <a href="../Typealiases.html#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a> + </li> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>NSDate</h1> + <p>Undocumented</p> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FE11UsergridSDKCSo6NSDatecFT12millisecondsSS_S0_"></a> + <a name="//apple_ref/swift/Method/init(milliseconds:)" class="dashAnchor"></a> + <a class="token" href="#/s:FE11UsergridSDKCSo6NSDatecFT12millisecondsSS_S0_">init(milliseconds:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Creates a new <code><a href="../Extensions/NSDate.html">NSDate</a></code> object with the given milliseconds.</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">milliseconds</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>milliseconds</em> + </code> + </td> + <td> + <div> + <p>the milliseconds</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>A new <code><a href="../Extensions/NSDate.html">NSDate</a></code> object.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FE11UsergridSDKCSo6NSDate18dateAsMillisecondsFT_Si"></a> + <a name="//apple_ref/swift/Method/dateAsMilliseconds()" class="dashAnchor"></a> + <a class="token" href="#/s:FE11UsergridSDKCSo6NSDate18dateAsMillisecondsFT_Si">dateAsMilliseconds()</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to milliseconds.</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">dateAsMilliseconds</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Int</span></code></pre> + + </div> + </div> + <div> + <h4>Return Value</h4> + <p>The number of milliseconds corresponding to the date.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FE11UsergridSDKCSo6NSDate24dateAsMillisecondsStringFT_SS"></a> + <a name="//apple_ref/swift/Method/dateAsMillisecondsString()" class="dashAnchor"></a> + <a class="token" href="#/s:FE11UsergridSDKCSo6NSDate24dateAsMillisecondsStringFT_SS">dateAsMillisecondsString()</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to milliseconds and returns the value as a string.</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">dateAsMillisecondsString</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre> + + </div> + </div> + <div> + <h4>Return Value</h4> + <p>The number of milliseconds corresponding to the date as a string.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:ZFE11UsergridSDKCSo6NSDate22stringFromMillesecondsFSiSS"></a> + <a name="//apple_ref/swift/Method/stringFromMilleseconds(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate22stringFromMillesecondsFSiSS">stringFromMilleseconds(_:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Converts the number of milliseconds to a string.</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">stringFromMilleseconds</span><span class="p">(</span><span class="nv">milliseconds</span><span class="p">:</span><span class="kt">Int</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>milliseconds</em> + </code> + </td> + <td> + <div> + <p>the milliseconds to convert</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The milliseconds as a string.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:ZFE11UsergridSDKCSo6NSDate19unixTimeStampStringFT_SS"></a> + <a name="//apple_ref/swift/Method/unixTimeStampString()" class="dashAnchor"></a> + <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate19unixTimeStampStringFT_SS">unixTimeStampString()</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to the corresponding UNIX time stamp as a string.</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">unixTimeStampString</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre> + + </div> + </div> + <div> + <h4>Return Value</h4> + <p>The UNIX time stamp as a string.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:ZFE11UsergridSDKCSo6NSDate13unixTimeStampFT_Si"></a> + <a name="//apple_ref/swift/Method/unixTimeStamp()" class="dashAnchor"></a> + <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate13unixTimeStampFT_Si">unixTimeStamp()</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Converts the <code><a href="../Extensions/NSDate.html">NSDate</a></code> object to the corresponding UNIX time stamp.</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">unixTimeStamp</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Int</span></code></pre> + + </div> + </div> + <div> + <h4>Return Value</h4> + <p>The UNIX time stamp.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:ZFE11UsergridSDKCSo6NSDate17nowAsMillisecondsFT_Si"></a> + <a name="//apple_ref/swift/Method/nowAsMilliseconds()" class="dashAnchor"></a> + <a class="token" href="#/s:ZFE11UsergridSDKCSo6NSDate17nowAsMillisecondsFT_Si">nowAsMilliseconds()</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Converts the current date to milliseconds.</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">nowAsMilliseconds</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Int</span></code></pre> + + </div> + </div> + <div> + <h4>Return Value</h4> + <p>The milliseconds of the current date.</p> + + </div> + </section> + </div> + </li> + </ul> + </div> + </section> + </section> + <section id="footer"> + <p>© 2016 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p> + <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« 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>
http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/8283a6dd/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAsset.html ---------------------------------------------------------------------- diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAsset.html b/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAsset.html new file mode 100644 index 0000000..e570062 --- /dev/null +++ b/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAsset.html @@ -0,0 +1,184 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridAsset Extension 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/Extension/UsergridAsset" class="dashAnchor"></a> + <a title="UsergridAsset Extension Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html"> Docs</a></p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html"> Reference</a> + <img id="carat" src="../img/carat.png" /> + UsergridAsset Extension 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/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/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/UsergridEntityProperties.html">UsergridEntityProperties</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Extensions.html">Extensions</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Extensions/UsergridAsset.html">UsergridAsset</a> + </li> + <li class="nav-group-task"> + <a href="../Extensions/UsergridAuth.html">UsergridAuth</a> + </li> + <li class="nav-group-task"> + <a href="../Extensions/UsergridClient.html">UsergridClient</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Protocols.html">Protocols</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Protocols/UsergridAuth.html">UsergridAuth</a> + </li> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>UsergridAsset</h1> + <p>Undocumented</p> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:vC11UsergridSDK13UsergridAsset17multiPartHTTPBodyCSo6NSData"></a> + <a name="//apple_ref/swift/Property/multiPartHTTPBody" class="dashAnchor"></a> + <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset17multiPartHTTPBodyCSo6NSData">multiPartHTTPBody</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> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK13UsergridAsset16multipartRequestFS0_FCSo5NSURLCSo19NSMutableURLRequest"></a> + <a name="//apple_ref/swift/Method/multipartRequest(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridAsset16multipartRequestFS0_FCSo5NSURLCSo19NSMutableURLRequest">multipartRequest(_:)</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> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FC11UsergridSDK13UsergridAsset23multipartRequestAndBodyFS0_FCSo5NSURLT7requestCSo19NSMutableURLRequest13multipartDataCSo6NSData_"></a> + <a name="//apple_ref/swift/Method/multipartRequestAndBody(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FC11UsergridSDK13UsergridAsset23multipartRequestAndBodyFS0_FCSo5NSURLT7requestCSo19NSMutableURLRequest13multipartDataCSo6NSData_">multipartRequestAndBody(_:)</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> + </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-10-20)</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> http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/8283a6dd/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAuth.html ---------------------------------------------------------------------- diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAuth.html b/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAuth.html new file mode 100644 index 0000000..ff7b963 --- /dev/null +++ b/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UsergridAuth.html @@ -0,0 +1,260 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridAuth Extension 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/Extension/UsergridAuth" class="dashAnchor"></a> + <a title="UsergridAuth Extension Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html"> Docs</a> (46% 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 Extension 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/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/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/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/UsergridUserProperties.html">UsergridUserProperties</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Extensions.html">Extensions</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Extensions/UsergridAuth.html">UsergridAuth</a> + </li> + <li class="nav-group-task"> + <a href="../Extensions/UsergridClient.html">UsergridClient</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Protocols.html">Protocols</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Protocols/UsergridAuth.html">UsergridAuth</a> + </li> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>UsergridAuth</h1> + <p>Undocumented</p> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:veRq_11UsergridSDK12UsergridAuth_S_S0_8hasTokenSb"></a> + <a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a> + <a class="token" href="#/s:veRq_11UsergridSDK12UsergridAuth_S_S0_8hasTokenSb">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:veRq_11UsergridSDK12UsergridAuth_S_S0_12tokenIsValidSb"></a> + <a name="//apple_ref/swift/Property/tokenIsValid" class="dashAnchor"></a> + <a class="token" href="#/s:veRq_11UsergridSDK12UsergridAuth_S_S0_12tokenIsValidSb">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:veRq_11UsergridSDK12UsergridAuth_S_S0_9isExpiredSb"></a> + <a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a> + <a class="token" href="#/s:veRq_11UsergridSDK12UsergridAuth_S_S0_9isExpiredSb">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:FeRq_11UsergridSDK12UsergridAuth_S_S0_16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest"></a> + <a name="//apple_ref/swift/Method/buildAuthRequest(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FeRq_11UsergridSDK12UsergridAuth_S_S0_16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest">buildAuthRequest(_:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Builds an authorization request which is can be used to retrieve the access token.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">buildAuthRequest</span><span class="p">(</span><span class="nv">baseURL</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">NSURLRequest</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>baseURL</em> + </code> + </td> + <td> + <div> + <p>The base URL of the access token request.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>A <code>NSURLRequest</code> object.</p> + + </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-10-21)</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>
