| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <title>UsergridAuthMode Enum 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/Enum/UsergridAuthMode" class="dashAnchor"></a> |
| <a title="UsergridAuthMode Enum 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" /> |
| UsergridAuthMode Enum 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>UsergridAuthMode</h1> |
| <div class="declaration"> |
| <div class="language"> |
| <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridAuthMode</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> |
| |
| </div> |
| </div> |
| <p>An enumeration that is used to determine what the <code><a href="../Classes/UsergridClient.html">UsergridClient</a></code> will use for authorization.</p> |
| |
| </section> |
| <section class="section task-group-section"> |
| <div class="task-group"> |
| <ul> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:FO11UsergridSDK16UsergridAuthMode4NoneFMS0_S0_"></a> |
| <a name="//apple_ref/swift/Element/None" class="dashAnchor"></a> |
| <a class="token" href="#/s:FO11UsergridSDK16UsergridAuthMode4NoneFMS0_S0_">None</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code.</p> |
| |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| <div class="language"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="k">case</span> <span class="kt">None</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <ul> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:FO11UsergridSDK16UsergridAuthMode4UserFMS0_S0_"></a> |
| <a name="//apple_ref/swift/Element/User" class="dashAnchor"></a> |
| <a class="token" href="#/s:FO11UsergridSDK16UsergridAuthMode4UserFMS0_S0_">User</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>If a non-expired <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient11currentUserGSqCS_12UsergridUser_">UsergridClient.currentUser</a></code>, this token is used to authenticate all API calls.</p> |
| |
| <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).</p> |
| |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| <div class="language"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="k">case</span> <span class="kt">User</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <ul> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:FO11UsergridSDK16UsergridAuthMode3AppFMS0_S0_"></a> |
| <a name="//apple_ref/swift/Element/App" class="dashAnchor"></a> |
| <a class="token" href="#/s:FO11UsergridSDK16UsergridAuthMode3AppFMS0_S0_">App</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>If a non-expired <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> exists in <code><a href="../Classes/UsergridClient.html#/s:vC11UsergridSDK14UsergridClient7appAuthGSqCS_15UsergridAppAuth_">UsergridClient.appAuth</a></code>, this token is used to authenticate all API calls.</p> |
| |
| <p>If the API call fails, the activity is treated as a failure with an appropriate HTTP status code (This behavior is identical to authMode=.None).</p> |
| |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| <div class="language"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="k">case</span> <span class="kt">App</span></code></pre> |
| |
| </div> |
| </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> |