http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/8283a6dd/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html ---------------------------------------------------------------------- diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html b/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html new file mode 100644 index 0000000..a4736a3 --- /dev/null +++ b/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDeviceProperties.html @@ -0,0 +1,369 @@ +<!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> (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" /> + 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/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>UsergridDeviceProperties</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">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="language"> + <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="language"> + <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="language"> + <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:ZFO11UsergridSDK24UsergridDeviceProperties10fromStringFSSGSqS0__"></a> + <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:ZFO11UsergridSDK24UsergridDeviceProperties10fromStringFSSGSqS0__">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><a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a></code> from a string if it’s valid.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">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><a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a></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="language"> + <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>© 2016 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p> + <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.5.0</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> + </section> + </article> + </div> + </body> +</div> +</html>
http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/8283a6dd/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html ---------------------------------------------------------------------- diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html b/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html new file mode 100644 index 0000000..d11978c --- /dev/null +++ b/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridDirection.html @@ -0,0 +1,286 @@ +<!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> (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" /> + 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/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>UsergridDirection</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">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="language"> + <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="language"> + <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="language"> + <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>© 2016 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p> + <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.5.0</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> + </section> + </article> + </div> + </body> +</div> +</html> http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/8283a6dd/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html ---------------------------------------------------------------------- diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html b/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html new file mode 100644 index 0000000..b9b3278 --- /dev/null +++ b/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridEntityProperties.html @@ -0,0 +1,514 @@ +<!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> (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" /> + 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/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>UsergridEntityProperties</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">UsergridEntityProperties</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> + + </div> + </div> + <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> + + </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="language"> + <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="language"> + <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="language"> + <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="language"> + <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="language"> + <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="language"> + <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:ZFO11UsergridSDK24UsergridEntityProperties10fromStringFSSGSqS0__"></a> + <a name="//apple_ref/swift/Method/fromString(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:ZFO11UsergridSDK24UsergridEntityProperties10fromStringFSSGSqS0__">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><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> from a string if it’s valid.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">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><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></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="language"> + <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:FO11UsergridSDK24UsergridEntityProperties18isMutableForEntityFCS_14UsergridEntitySb"></a> + <a name="//apple_ref/swift/Method/isMutableForEntity(_:)" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridEntityProperties18isMutableForEntityFCS_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><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> is mutable for the given entity.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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><a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a></code> is mutable for the given entity</p> + + </div> + </section> + </div> + </li> + </ul> + </div> + </section> + </section> + <section id="footer"> + <p>© 2016 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p> + <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.5.0</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> + </section> + </article> + </div> + </body> +</div> +</html> http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/8283a6dd/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridHttpMethod.html ---------------------------------------------------------------------- diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridHttpMethod.html b/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridHttpMethod.html new file mode 100644 index 0000000..1ad6cbb --- /dev/null +++ b/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridHttpMethod.html @@ -0,0 +1,341 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridHttpMethod 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/UsergridHttpMethod" class="dashAnchor"></a> + <a title="UsergridHttpMethod 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" /> + UsergridHttpMethod 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>UsergridHttpMethod</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">UsergridHttpMethod</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> + + </div> + </div> + <p>An enumeration for defining the HTTP methods used by Usergrid.</p> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK18UsergridHttpMethod3GetFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Get" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod3GetFMS0_S0_">Get</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>GET</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">Get</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK18UsergridHttpMethod3PutFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Put" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod3PutFMS0_S0_">Put</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>PUT</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">Put</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK18UsergridHttpMethod4PostFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Post" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod4PostFMS0_S0_">Post</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>POST</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">Post</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK18UsergridHttpMethod6DeleteFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Delete" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK18UsergridHttpMethod6DeleteFMS0_S0_">Delete</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>DELETE</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">Delete</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:vO11UsergridSDK18UsergridHttpMethod11stringValueSS"></a> + <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a> + <a class="token" href="#/s:vO11UsergridSDK18UsergridHttpMethod11stringValueSS">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="language"> + <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>© 2016 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p> + <p>Generated by <a class="link" href="https://github.com/realm/jazzy"; target="_blank" rel="external">jazzy âªâ« v0.5.0</a>, a <a class="link" href="http://realm.io"; target="_blank" rel="external">Realm</a> project.</p> + </section> + </article> + </div> + </body> +</div> +</html> http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/8283a6dd/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridImageContentType.html ---------------------------------------------------------------------- diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridImageContentType.html b/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridImageContentType.html new file mode 100644 index 0000000..224450b --- /dev/null +++ b/docs/docsets/.docset/Contents/Resources/Documents/Enums/UsergridImageContentType.html @@ -0,0 +1,286 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>UsergridImageContentType 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/UsergridImageContentType" class="dashAnchor"></a> + <a title="UsergridImageContentType 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" /> + UsergridImageContentType 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>UsergridImageContentType</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">UsergridImageContentType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> + + </div> + </div> + <p><code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> image specific content types.</p> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridImageContentType3PngFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Png" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridImageContentType3PngFMS0_S0_">Png</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Content type: ‘image/png’</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">Png</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/s:FO11UsergridSDK24UsergridImageContentType4JpegFMS0_S0_"></a> + <a name="//apple_ref/swift/Element/Jpeg" class="dashAnchor"></a> + <a class="token" href="#/s:FO11UsergridSDK24UsergridImageContentType4JpegFMS0_S0_">Jpeg</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Content type: ‘image/jpeg’</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">Jpeg</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:vO11UsergridSDK24UsergridImageContentType11stringValueSS"></a> + <a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a> + <a class="token" href="#/s:vO11UsergridSDK24UsergridImageContentType11stringValueSS">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="language"> + <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>© 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>
