http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser/UsergridUserProperties.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser/UsergridUserProperties.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser/UsergridUserProperties.html deleted file mode 100644 index e6c7cf6..0000000 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUser/UsergridUserProperties.html +++ /dev/null @@ -1,346 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <title>UsergridUserProperties 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/UsergridUserProperties" class="dashAnchor"></a> - <a title="UsergridUserProperties Enum Reference"></a> - <header> - <div class="content-wrapper"> - <p><a href="../../index.html"> Docs</a> (43% documented)</p> - </div> - </header> - <div class="content-wrapper"> - <p id="breadcrumbs"> - <a href="../../index.html"> Reference</a> - <img id="carat" src="../../img/carat.png" /> - UsergridUserProperties 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/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/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>UsergridUserProperties</h1> - <p>Undocumented</p> - - </section> - <section class="section task-group-section"> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties4NameFMS1_S1_"></a> - <a name="//apple_ref/swift/Element/Name" class="dashAnchor"></a> - <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties4NameFMS1_S1_">Name</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> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8UsernameFMS1_S1_"></a> - <a name="//apple_ref/swift/Element/Username" class="dashAnchor"></a> - <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8UsernameFMS1_S1_">Username</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> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8PasswordFMS1_S1_"></a> - <a name="//apple_ref/swift/Element/Password" class="dashAnchor"></a> - <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8PasswordFMS1_S1_">Password</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> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties5EmailFMS1_S1_"></a> - <a name="//apple_ref/swift/Element/Email" class="dashAnchor"></a> - <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties5EmailFMS1_S1_">Email</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> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties3AgeFMS1_S1_"></a> - <a name="//apple_ref/swift/Element/Age" class="dashAnchor"></a> - <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties3AgeFMS1_S1_">Age</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> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties9ActivatedFMS1_S1_"></a> - <a name="//apple_ref/swift/Element/Activated" class="dashAnchor"></a> - <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties9ActivatedFMS1_S1_">Activated</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> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8DisabledFMS1_S1_"></a> - <a name="//apple_ref/swift/Element/Disabled" class="dashAnchor"></a> - <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties8DisabledFMS1_S1_">Disabled</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> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties7PictureFMS1_S1_"></a> - <a name="//apple_ref/swift/Element/Picture" class="dashAnchor"></a> - <a class="token" href="#/s:FOC11UsergridSDK12UsergridUser22UsergridUserProperties7PictureFMS1_S1_">Picture</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> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:ZFOC11UsergridSDK12UsergridUser22UsergridUserProperties10fromStringFMS1_FSSGSqS1__"></a> - <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:ZFOC11UsergridSDK12UsergridUser22UsergridUserProperties10fromStringFMS1_FSSGSqS1__">fromString(_:)</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:vOC11UsergridSDK12UsergridUser22UsergridUserProperties11stringValueSS"></a> - <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a> - <a class="token" href="#/s:vOC11UsergridSDK12UsergridUser22UsergridUserProperties11stringValueSS">stringValue</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/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html deleted file mode 100644 index 15b46fb..0000000 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridUserAuth.html +++ /dev/null @@ -1,410 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <title>UsergridUserAuth 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/UsergridUserAuth" class="dashAnchor"></a> - <a title="UsergridUserAuth Class 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" /> - UsergridUserAuth 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/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>UsergridUserAuth</h1> - <div class="declaration"> - <div class="language"> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridUserAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre> - - </div> - </div> - <p>The <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> subclass used for user level authorization.</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:vC11UsergridSDK16UsergridUserAuth8usernameSS"></a> - <a name="//apple_ref/swift/Property/username" class="dashAnchor"></a> - <a class="token" href="#/s:vC11UsergridSDK16UsergridUserAuth8usernameSS">username</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>The username associated with the User.</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">let</span> <span class="nv">username</span><span class="p">:</span> <span class="kt">String</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:FC11UsergridSDK16UsergridUserAuthcFT8usernameSS8passwordSS_S0_"></a> - <a name="//apple_ref/swift/Method/init(username:password:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK16UsergridUserAuthcFT8usernameSS8passwordSS_S0_">init(username:password:)</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>Designated initializer for <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a></code> objects.</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">username</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">password</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>username</em> - </code> - </td> - <td> - <div> - <p>The username associated with the User.</p> - - </div> - </td> - </tr> - <tr> - <td> - <code> - <em>password</em> - </code> - </td> - <td> - <div> - <p>The password associated with the User.</p> - - </div> - </td> - </tr> - </tbody> - </table> - </div> - <div> - <h4>Return Value</h4> - <p>A new instance of <code><a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</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:FC11UsergridSDK16UsergridUserAuthcFT5coderCSo7NSCoder_GSqS0__"></a> - <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK16UsergridUserAuthcFT5coderCSo7NSCoder_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/UsergridUserAuth.html">UsergridUserAuth</a></code> object.</p> - - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:FC11UsergridSDK16UsergridUserAuth15encodeWithCoderFCSo7NSCoderT_"></a> - <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a> - <a class="token" href="#/s:FC11UsergridSDK16UsergridUserAuth15encodeWithCoderFCSo7NSCoderT_">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="k">override</span> <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> - </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/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums.html deleted file mode 100644 index 56fabb8..0000000 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums.html +++ /dev/null @@ -1,435 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <title>Enums 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 title="Enums 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" /> - Enums 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>Enums</h1> - <p>The following enums are available globally.</p> - - </section> - <section class="section task-group-section"> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:O11UsergridSDK16UsergridAuthMode"></a> - <a name="//apple_ref/swift/Enum/UsergridAuthMode" class="dashAnchor"></a> - <a class="token" href="#/s:O11UsergridSDK16UsergridAuthMode">UsergridAuthMode</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>An enumeration that is used to determine what the <code><a href="Classes/UsergridClient.html">UsergridClient</a></code> will use for authorization.</p> - - <a href="Enums/UsergridAuthMode.html" class="slightly-smaller">See more</a> - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <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> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:O11UsergridSDK24UsergridEntityProperties"></a> - <a name="//apple_ref/swift/Enum/UsergridEntityProperties" class="dashAnchor"></a> - <a class="token" href="#/s:O11UsergridSDK24UsergridEntityProperties">UsergridEntityProperties</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p><code><a href="Classes/UsergridEntity.html">UsergridEntity</a></code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p> - - <a href="Enums/UsergridEntityProperties.html" class="slightly-smaller">See more</a> - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridEntityProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:O11UsergridSDK24UsergridDeviceProperties"></a> - <a name="//apple_ref/swift/Enum/UsergridDeviceProperties" class="dashAnchor"></a> - <a class="token" href="#/s:O11UsergridSDK24UsergridDeviceProperties">UsergridDeviceProperties</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p><code>UsergridDeviceProperties</code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p> - - <a href="Enums/UsergridDeviceProperties.html" class="slightly-smaller">See more</a> - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridDeviceProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:O11UsergridSDK22UsergridUserProperties"></a> - <a name="//apple_ref/swift/Enum/UsergridUserProperties" class="dashAnchor"></a> - <a class="token" href="#/s:O11UsergridSDK22UsergridUserProperties">UsergridUserProperties</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p><code><a href="Classes/UsergridUser.html">UsergridUser</a></code> specific properties keys.</p> - - <a href="Enums/UsergridUserProperties.html" class="slightly-smaller">See more</a> - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridUserProperties</span><span class="p">:</span> <span class="kt">Int</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:O11UsergridSDK21UsergridQueryOperator"></a> - <a name="//apple_ref/swift/Enum/UsergridQueryOperator" class="dashAnchor"></a> - <a class="token" href="#/s:O11UsergridSDK21UsergridQueryOperator">UsergridQueryOperator</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p><code><a href="Classes/UsergridQuery.html">UsergridQuery</a></code> specific operators.</p> - - <a href="Enums/UsergridQueryOperator.html" class="slightly-smaller">See more</a> - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridQueryOperator</span><span class="p">:</span> <span class="kt">Int</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:O11UsergridSDK22UsergridQuerySortOrder"></a> - <a name="//apple_ref/swift/Enum/UsergridQuerySortOrder" class="dashAnchor"></a> - <a class="token" href="#/s:O11UsergridSDK22UsergridQuerySortOrder">UsergridQuerySortOrder</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p><code><a href="Classes/UsergridQuery.html">UsergridQuery</a></code> specific sort orders.</p> - - <a href="Enums/UsergridQuerySortOrder.html" class="slightly-smaller">See more</a> - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridQuerySortOrder</span><span class="p">:</span> <span class="kt">Int</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:O11UsergridSDK24UsergridImageContentType"></a> - <a name="//apple_ref/swift/Enum/UsergridImageContentType" class="dashAnchor"></a> - <a class="token" href="#/s:O11UsergridSDK24UsergridImageContentType">UsergridImageContentType</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p><code><a href="Classes/UsergridAsset.html">UsergridAsset</a></code> image specific content types.</p> - - <a href="Enums/UsergridImageContentType.html" class="slightly-smaller">See more</a> - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridImageContentType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:O11UsergridSDK17UsergridDirection"></a> - <a name="//apple_ref/swift/Enum/UsergridDirection" class="dashAnchor"></a> - <a class="token" href="#/s:O11UsergridSDK17UsergridDirection">UsergridDirection</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>An enumeration that is used when getting connections to entity objects. Used to determine which the direction of the connection is wanted.</p> - - <a href="Enums/UsergridDirection.html" class="slightly-smaller">See more</a> - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridDirection</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> - - </div> - </div> - </section> - </div> - </li> - <li class="item"> - <div> - <code> - <a name="/s:O11UsergridSDK18UsergridHttpMethod"></a> - <a name="//apple_ref/swift/Enum/UsergridHttpMethod" class="dashAnchor"></a> - <a class="token" href="#/s:O11UsergridSDK18UsergridHttpMethod">UsergridHttpMethod</a> - </code> - </div> - <div class="height-container"> - <div class="pointer-container"></div> - <section class="section"> - <div class="pointer"></div> - <div class="abstract"> - <p>An enumeration for defining the HTTP methods used by Usergrid.</p> - - <a href="Enums/UsergridHttpMethod.html" class="slightly-smaller">See more</a> - </div> - <div class="declaration"> - <h4>Declaration</h4> - <div class="language"> - <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">@objc</span> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UsergridHttpMethod</span> <span class="p">:</span> <span class="kt">Int</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> http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthFallback.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthFallback.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthFallback.html deleted file mode 100644 index 13d19bc..0000000 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthFallback.html +++ /dev/null @@ -1,248 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <title>UsergridAuthFallback 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/UsergridAuthFallback" class="dashAnchor"></a> - <a title="UsergridAuthFallback Enum 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" /> - UsergridAuthFallback 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/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>UsergridAuthFallback</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">UsergridAuthFallback</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 fallback to depending on certain authorization conditions.</p> - - </section> - <section class="section task-group-section"> - <div class="task-group"> - <ul> - <li class="item"> - <div> - <code> - <a name="/s:FO11UsergridSDK20UsergridAuthFallback4NoneFMS0_S0_"></a> - <a name="//apple_ref/swift/Element/None" class="dashAnchor"></a> - <a class="token" href="#/s:FO11UsergridSDK20UsergridAuthFallback4NoneFMS0_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 a non-expired user auth token 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.</p> - -<p>If a non-expired user auth token does not exist, all API calls will be made unauthenticated.</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:FO11UsergridSDK20UsergridAuthFallback3AppFMS0_S0_"></a> - <a name="//apple_ref/swift/Element/App" class="dashAnchor"></a> - <a class="token" href="#/s:FO11UsergridSDK20UsergridAuthFallback3AppFMS0_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 user auth token 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 authFallback=.None).</p> - -<p>If a non-expired user auth does not exist, all API calls will be made using stored app auth.</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="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 âªâ« 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/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html deleted file mode 100644 index 7ed672a..0000000 --- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthMode.html +++ /dev/null @@ -1,283 +0,0 @@ -<!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>
