http://git-wip-us.apache.org/repos/asf/usergrid/blob/7442c881/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 new file mode 100644 index 0000000..38c02ef --- /dev/null +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -0,0 +1,372 @@ +<!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> (97% 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/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/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/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/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> + </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:O11UsergridSDK20UsergridAuthFallback"></a> + <a name="//apple_ref/swift/Enum/UsergridAuthFallback" class="dashAnchor"></a> + <a class="token" href="#/s:O11UsergridSDK20UsergridAuthFallback">UsergridAuthFallback</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>UsergridClient</code> will fallback to depending on certain authorization conditions.</p> + + <a href="Enums/UsergridAuthFallback.html" class="slightly-smaller">See more</a> + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <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">UsergridAuthFallback</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>UsergridEntity</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="Swift"> + <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="Swift"> + <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>UsergridUser</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="Swift"> + <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>UsergridQuery</code> specific operators.</p> + + <a href="Enums/UsergridQueryOperator.html" class="slightly-smaller">See more</a> + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <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>UsergridQuery</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="Swift"> + <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>UsergridAsset</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="Swift"> + <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="Swift"> + <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> + </ul> + </div> + </section> + </section> + <section id="footer"> + <p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-12-18)</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/7442c881/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 new file mode 100644 index 0000000..536c10d --- /dev/null +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridAuthFallback.html @@ -0,0 +1,221 @@ +<!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"> Docs</a> (97% documented)</p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html"> 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/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/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/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/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> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>UsergridAuthFallback</h1> + <div class="declaration"> + <div class="Swift"> + <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>UsergridClient</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>UsergridClient.currentUser</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="Swift"> + <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>UsergridClient.currentUser</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="Swift"> + <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>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-12-18)</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/7442c881/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html new file mode 100644 index 0000000..9a8f620 --- /dev/null +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html @@ -0,0 +1,334 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridDeviceProperties 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/UsergridDeviceProperties" class="dashAnchor"></a> + <a title="UsergridDeviceProperties Enum Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html"> Docs</a> (97% documented)</p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html"> Reference</a> + <img id="carat" src="../img/carat.png" /> + UsergridDeviceProperties 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/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/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/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/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> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>UsergridDeviceProperties</h1> + <div class="declaration"> + <div class="Swift"> + <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> + <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> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridDeviceProperties5ModelFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Model" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridDeviceProperties5ModelFMS0_S0_">Model</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Corresponds to the property ‘deviceModel’</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">Model</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridDeviceProperties8PlatformFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Platform" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridDeviceProperties8PlatformFMS0_S0_">Platform</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Corresponds to the property ‘devicePlatform’</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">Platform</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridDeviceProperties9OSVersionFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/OSVersion" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridDeviceProperties9OSVersionFMS0_S0_">OSVersion</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Corresponds to the property ‘deviceOSVersion’</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">OSVersion</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <div class="task-name-container"> + <a name="/Methods"></a> + <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> + <a href="#/Methods"> + <h3 class="section-name">Methods</h3> + </a> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:ZFO11UsergridSDK24UsergridDeviceProperties10fromStringFMS0_FSSGSqS0__"></a> + <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:ZFO11UsergridSDK24UsergridDeviceProperties10fromStringFMS0_FSSGSqS0__">fromString(_:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Gets the corresponding <code>UsergridDeviceProperties</code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridDeviceProperties</span><span class="p">?</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>stringValue</em> + </code> + </td> + <td> + <div> + <p>The string value to convert.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The corresponding <code>UsergridDeviceProperties</code> or nil.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vO11UsergridSDK24UsergridDeviceProperties11stringValueSS"></a> + <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a> + <a class="token" href="#/s:vO11UsergridSDK24UsergridDeviceProperties11stringValueSS">stringValue</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre> + + </div> + </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-12-18)</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/7442c881/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html new file mode 100644 index 0000000..a5bc4f8 --- /dev/null +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html @@ -0,0 +1,251 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridDirection 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/UsergridDirection" class="dashAnchor"></a> + <a title="UsergridDirection Enum Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html"> Docs</a> (97% documented)</p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html"> Reference</a> + <img id="carat" src="../img/carat.png" /> + UsergridDirection 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/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/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/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/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> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>UsergridDirection</h1> + <div class="declaration"> + <div class="Swift"> + <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> + <p>An enumeration that is used when getting connections to entity objects. Used to determine which the direction of the connection is wanted.</p> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK17UsergridDirection2InFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/In" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK17UsergridDirection2InFMS0_S0_">In</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>To get the entities that have created a connection to an entity. aka <code>connecting</code></p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">In</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK17UsergridDirection3OutFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Out" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK17UsergridDirection3OutFMS0_S0_">Out</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>To get the entities an entity has connected to. aka <code>connections</code></p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">Out</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <div class="task-name-container"> + <a name="/Methods"></a> + <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> + <a href="#/Methods"> + <h3 class="section-name">Methods</h3> + </a> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:vO11UsergridSDK17UsergridDirection15connectionValueSS"></a> + <a name="//apple_ref/swift/Property/connectionValue" class="dashAnchor"></a> + <a class="token" href="#/s:vO11UsergridSDK17UsergridDirection15connectionValueSS">connectionValue</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Returns the connection value.</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">connectionValue</span><span class="p">:</span> <span class="kt">String</span></code></pre> + + </div> + </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-12-18)</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/7442c881/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html new file mode 100644 index 0000000..f63a4ae --- /dev/null +++ b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html @@ -0,0 +1,479 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridEntityProperties 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/UsergridEntityProperties" class="dashAnchor"></a> + <a title="UsergridEntityProperties Enum Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html"> Docs</a> (97% documented)</p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html"> Reference</a> + <img id="carat" src="../img/carat.png" /> + UsergridEntityProperties 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/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/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/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/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> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>UsergridEntityProperties</h1> + <div class="declaration"> + <div class="Swift"> + <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> + <p><code>UsergridEntity</code> specific properties keys. Note that trying to mutate the values of these properties will not be allowed in most cases.</p> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridEntityProperties10EntityTypeFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/EntityType" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties10EntityTypeFMS0_S0_">EntityType</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Corresponds to the property ‘type’</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">EntityType</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridEntityProperties4UUIDFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/UUID" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties4UUIDFMS0_S0_">UUID</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Corresponds to the property ‘uuid’</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">UUID</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridEntityProperties4NameFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Name" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties4NameFMS0_S0_">Name</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Corresponds to the property ‘name’</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">Name</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridEntityProperties7CreatedFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Created" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties7CreatedFMS0_S0_">Created</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Corresponds to the property ‘created’</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">Created</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridEntityProperties8ModifiedFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Modified" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties8ModifiedFMS0_S0_">Modified</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Corresponds to the property ‘modified’</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">Modified</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridEntityProperties8LocationFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Location" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties8LocationFMS0_S0_">Location</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Corresponds to the property ‘location’</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="Swift"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="k">case</span> <span class="kt">Location</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <div class="task-name-container"> + <a name="/Methods"></a> + <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> + <a href="#/Methods"> + <h3 class="section-name">Methods</h3> + </a> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:ZFO11UsergridSDK24UsergridEntityProperties10fromStringFMS0_FSSGSqS0__"></a> + <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:ZFO11UsergridSDK24UsergridEntityProperties10fromStringFMS0_FSSGSqS0__">fromString(_:)</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Gets the corresponding <code>UsergridEntityProperties</code> from a string if it’s valid.</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">static</span> <span class="kd">func</span> <span class="nf">fromString</span><span class="p">(</span><span class="nv">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UsergridEntityProperties</span><span class="p">?</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>stringValue</em> + </code> + </td> + <td> + <div> + <p>The string value to convert.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The corresponding <code>UsergridEntityProperties</code> or nil.</p> + + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:vO11UsergridSDK24UsergridEntityProperties11stringValueSS"></a> + <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a> + <a class="token" href="#/s:vO11UsergridSDK24UsergridEntityProperties11stringValueSS">stringValue</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Returns the string value.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridEntityProperties18isMutableForEntityFS0_FCS_14UsergridEntitySb"></a> + <a name="//apple_ref/swift/Method/isMutableForEntity(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties18isMutableForEntityFS0_FCS_14UsergridEntitySb">isMutableForEntity(_:)</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 <code>UsergridEntityProperties</code> is mutable for the given entity.</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">isMutableForEntity</span><span class="p">(</span><span class="nv">entity</span><span class="p">:</span><span class="kt">UsergridEntity</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>entity</em> + </code> + </td> + <td> + <div> + <p>The entity to check.</p> + + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>If the <code>UsergridEntityProperties</code> is mutable for the given entity</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-12-18)</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>
