blob: dfaaf0d22c93471b526eee21d4b5bd727dcda32a [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<title>UsergridAuth Protocol 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/Protocol/UsergridAuth" class="dashAnchor"></a>
<a title="UsergridAuth Protocol 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 Protocol 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:vP11UsergridSDK12UsergridAuth11accessTokenGSqSS_"></a>
<a name="//apple_ref/swift/Property/accessToken" class="dashAnchor"></a>
<a class="token" href="#/s:vP11UsergridSDK12UsergridAuth11accessTokenGSqSS_">accessToken</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:vP11UsergridSDK12UsergridAuth9expiresInGSqSi_"></a>
<a name="//apple_ref/swift/Property/expiresIn" class="dashAnchor"></a>
<a class="token" href="#/s:vP11UsergridSDK12UsergridAuth9expiresInGSqSi_">expiresIn</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:vP11UsergridSDK12UsergridAuth8hasTokenSb"></a>
<a name="//apple_ref/swift/Property/hasToken" class="dashAnchor"></a>
<a class="token" href="#/s:vP11UsergridSDK12UsergridAuth8hasTokenSb">hasToken</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:vP11UsergridSDK12UsergridAuth12tokenIsValidSb"></a>
<a name="//apple_ref/swift/Property/tokenIsValid" class="dashAnchor"></a>
<a class="token" href="#/s:vP11UsergridSDK12UsergridAuth12tokenIsValidSb">tokenIsValid</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:vP11UsergridSDK12UsergridAuth9isExpiredSb"></a>
<a name="//apple_ref/swift/Property/isExpired" class="dashAnchor"></a>
<a class="token" href="#/s:vP11UsergridSDK12UsergridAuth9isExpiredSb">isExpired</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:vP11UsergridSDK12UsergridAuth12jsonBodyDictGVSs10DictionarySSPSs9AnyObject__"></a>
<a name="//apple_ref/swift/Property/jsonBodyDict" class="dashAnchor"></a>
<a class="token" href="#/s:vP11UsergridSDK12UsergridAuth12jsonBodyDictGVSs10DictionarySSPSs9AnyObject__">jsonBodyDict</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:FP11UsergridSDK12UsergridAuth16buildAuthRequestuRq_S0__Fq_FSSCSo12NSURLRequest"></a>
<a name="//apple_ref/swift/Method/buildAuthRequest(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP11UsergridSDK12UsergridAuth16buildAuthRequestuRq_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>Undocumented</p>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-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>