You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2015/08/07 23:06:06 UTC
[12/21] incubator-usergrid git commit: Update website with latest
docs.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/sdks/ios.html
----------------------------------------------------------------------
diff --git a/content/docs/sdks/ios.html b/content/docs/sdks/ios.html
index e77c1c5..b3b4421 100644
--- a/content/docs/sdks/ios.html
+++ b/content/docs/sdks/ios.html
@@ -80,14 +80,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -115,6 +116,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -139,9 +141,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -156,6 +158,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -216,6 +219,128 @@
<div class="section" id="ios-sdk">
<h1>iOS SDK<a class="headerlink" href="#ios-sdk" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="version">
+<h2>Version<a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h2>
+<p>Current Version: <strong>0.9.2</strong></p>
+<p>Change log:</p>
+<p><a class="reference external" href="https://github.com/apigee/usergrid-javascript-sdk/blob/master/changelog.md">https://github.com/apigee/usergrid-javascript-sdk/blob/master/changelog.md</a></p>
+</div>
+<div class="section" id="overview">
+<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
+<p>This open source SDK simplifies writing iOS applications that connect to
+App Services (Usergrid). The repo is located here:</p>
+<p><a class="reference external" href="https://github.com/apigee/usergrid-ios-sdk">https://github.com/apigee/usergrid-ios-sdk</a></p>
+<p>You can download the SDK here:</p>
+<ul class="simple">
+<li>Download as a zip file:
+<a class="reference external" href="https://github.com/apigee/usergrid-ios-sdk/archive/master.zip">https://github.com/apigee/usergrid-ios-sdk/archive/master.zip</a></li>
+<li>Download as a tar.gz file:
+<a class="reference external" href="https://github.com/apigee/usergrid-ios-sdk/archive/master.tar.gz">https://github.com/apigee/usergrid-ios-sdk/archive/master.tar.gz</a></li>
+</ul>
+<p>To find out more about App Services, which is Apigee’s hosted Usergrid
+solution, see:</p>
+<p><a class="reference external" href="http://apigee.com/about/developers">http://apigee.com/about/developers</a></p>
+<p>To view the Apigee App Services documentation, see:</p>
+<p><a class="reference external" href="http://apigee.com/docs/app_services">http://apigee.com/docs/app_services</a></p>
+</div>
+<div class="section" id="installing">
+<h2>Installing<a class="headerlink" href="#installing" title="Permalink to this headline">¶</a></h2>
+<p>Once you have downloaded the SDK, add the UGAPI folder to your project
+by dragging and dropping it into your project.</p>
+<p><strong>Note:</strong> Make sure you check the “Copy items into destination group’s
+folder”, and also make sure the appropriate boxes are checked next to
+“Add to targets”.</p>
+</div>
+<div class="section" id="getting-started">
+<h2>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
+<p>If you haven’t done so, make sure you know your organization name and
+your application name. Your organization name will be the same as the
+username you signed up with.</p>
+<p>Within your organization, you can have multiple application namespaces.
+By default, an application named “Sandbox” has been created for you to
+use for testing, but you can also log into the <a class="reference external" href="http://apigee.com/usergrid">Admin
+Portal</a> and create an application with
+any name you want.</p>
+<p>Once you have your application name, you will want to create a UGClient
+object like so:</p>
+<div class="highlight-python"><div class="highlight"><pre>//configure the org and app
+NSString * orgName = @"ApigeeOrg";
+NSString * appName = @"MessageeApp";
+
+//make new client
+usergridClient = [[UGClient alloc]initWithOrganizationId: orgName withApplicationID: appName];
+</pre></div>
+</div>
+<p>Now use the usergridClient object to invoke other methods that access
+the API. For example, to log a user in:</p>
+<div class="highlight-python"><div class="highlight"><pre>[usergridClient logInUser:username password:password];
+UGUser *user = [usergridClient getLoggedInUser];
+</pre></div>
+</div>
+<p>Or, to create a user:</p>
+<div class="highlight-python"><div class="highlight"><pre>UGClientResponse *response = [usergridClient addUser:@"myusername" email:@"email@email.com" name:@"my name" password:@"mypassword"];
+if (response.transactionState == 0) {
+ //user created!
+}
+</pre></div>
+</div>
+</div>
+<div class="section" id="sample-code">
+<h2>Sample Code<a class="headerlink" href="#sample-code" title="Permalink to this headline">¶</a></h2>
+<p>If you are ready to look at a fully functional app that uses this SDK,
+check out our Messagee application. It is a twitter-type app that
+exercises many parts of the API including: Login / Authentication, GET
+and POST operations, activities (tweets), and social features such as
+following relationships.</p>
+<p>The Messagee Xcode project is located here:</p>
+<p><a class="reference external" href="https://github.com/apigee/usergrid-sample-ios-messagee">https://github.com/apigee/usergrid-sample-ios-messagee</a></p>
+</div>
+<div class="section" id="running-tests">
+<h2>Running Tests<a class="headerlink" href="#running-tests" title="Permalink to this headline">¶</a></h2>
+<p>The iOS SDK unit tests are written with Nu. You’ll need to install the
+language itself to run the tests, and use the Nukefile to create a
+Usergrid.framework. For installation directions go
+<a class="reference external" href="https://github.com/timburks/nu">here</a></p>
+<p>To compile the Usergrid SDK as an Objective-C framework simple type
+<code class="docutils literal"><span class="pre">nuke</span></code> to build the framework and then <code class="docutils literal"><span class="pre">nuke</span> <span class="pre">install</span></code> to install it
+in the /Library/Frameworks path.</p>
+<p>To run the unit tests written for the SDK use the command <code class="docutils literal"><span class="pre">nuke</span> <span class="pre">test</span></code>
+this will run all tests.</p>
+</div>
+<div class="section" id="contributing">
+<h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
+<p>We welcome your enhancements!</p>
+<p>Like <a class="reference external" href="https://github.com/apigee/usergrid-node-module">Usergrid</a>, the
+Usergrid Objective-C SDK is open source and licensed under the Apache
+License, Version 2.0.</p>
+<ol class="arabic simple">
+<li>Fork it</li>
+<li>Create your feature branch (<code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">-b</span> <span class="pre">my-new-feature</span></code>)</li>
+<li>Commit your changes (<code class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">-am</span> <span class="pre">'Added</span> <span class="pre">some</span> <span class="pre">feature'</span></code>)</li>
+<li>Push your changes to the upstream branch
+(<code class="docutils literal"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">my-new-feature</span></code>)</li>
+<li>Create new Pull Request (make sure you describe what you did and why
+your mod is needed)</li>
+</ol>
+</div>
+<div class="section" id="more-information">
+<h2>More information<a class="headerlink" href="#more-information" title="Permalink to this headline">¶</a></h2>
+<p>For more information on Apigee App Services, visit
+<a class="reference external" href="http://apigee.com/about/developers">http://apigee.com/about/developers</a>.</p>
+</div>
+<div class="section" id="copyright">
+<h2>Copyright<a class="headerlink" href="#copyright" title="Permalink to this headline">¶</a></h2>
+<p>Copyright 2013 Apigee Corporation</p>
+<p>Licensed under the Apache License, Version 2.0 (the “License”); you may
+not use this file except in compliance with the License. You may obtain
+a copy of the License at</p>
+<p><a class="reference external" href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
+<p>Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.</p>
+</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/sdks/sdk-outline.html
----------------------------------------------------------------------
diff --git a/content/docs/sdks/sdk-outline.html b/content/docs/sdks/sdk-outline.html
new file mode 100644
index 0000000..e2a42bb
--- /dev/null
+++ b/content/docs/sdks/sdk-outline.html
@@ -0,0 +1,503 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Usergrid SDK Documentation outline — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Usergrid SDK Documentation outline</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/sdks/sdk-outline.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="usergrid-sdk-documentation-outline">
+<h1>Usergrid SDK Documentation outline<a class="headerlink" href="#usergrid-sdk-documentation-outline" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="getting-started">
+<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="installing-the-sdk">
+<h3>Installing the SDK<a class="headerlink" href="#installing-the-sdk" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="building-from-source">
+<h3>Building from Source<a class="headerlink" href="#building-from-source" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+</div>
+<div class="section" id="usergrid-sdk-reference-with-examples">
+<h1>Usergrid SDK Reference with Examples<a class="headerlink" href="#usergrid-sdk-reference-with-examples" title="Permalink to this headline">¶</a></h1>
+<p>The 66 topics listed below are each documented in the Usergrid
+documentation and for each the docs provide an API reference and example
+for each of these clients: curl, iOS, Android, JavaScript, Ruby and
+Node.js.</p>
+<div class="section" id="working-with-collections">
+<h2>Working with Collections<a class="headerlink" href="#working-with-collections" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-collections">
+<h3>1. Creating collections<a class="headerlink" href="#creating-collections" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-collections">
+<h3>2. Retrieving collections<a class="headerlink" href="#retrieving-collections" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="updating-collections">
+<h3>3. Updating collections<a class="headerlink" href="#updating-collections" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="deleting-collections">
+<h3>4. Deleting collections<a class="headerlink" href="#deleting-collections" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="working-with-entities">
+<h2>Working with Entities<a class="headerlink" href="#working-with-entities" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-a-custom-entity">
+<h3>5. Creating a custom entity<a class="headerlink" href="#creating-a-custom-entity" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-multiple-custom-entities">
+<h3>6. Creating multiple custom entities<a class="headerlink" href="#creating-multiple-custom-entities" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-an-entity-with-sub-properties">
+<h3>7. Creating an entity with sub-properties<a class="headerlink" href="#creating-an-entity-with-sub-properties" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-an-entity">
+<h3>8. Retrieving an entity<a class="headerlink" href="#retrieving-an-entity" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-multiple-entities">
+<h3>9. Retrieving multiple entities<a class="headerlink" href="#retrieving-multiple-entities" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="updating-an-entity">
+<h3>10. Updating an entity<a class="headerlink" href="#updating-an-entity" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="updating-a-sub-property">
+<h3>11. Updating a sub-property<a class="headerlink" href="#updating-a-sub-property" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="deleting-data-entities">
+<h3>12. Deleting data entities<a class="headerlink" href="#deleting-data-entities" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="data-queries">
+<h2>Data Queries<a class="headerlink" href="#data-queries" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="querying-your-data">
+<h3>13. Querying your data<a class="headerlink" href="#querying-your-data" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="entity-connections">
+<h2>Entity Connections<a class="headerlink" href="#entity-connections" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="connecting-users-other-data">
+<h3>14. Connecting users other data<a class="headerlink" href="#connecting-users-other-data" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-user-connection-data">
+<h3>15. Retrieving user connection data<a class="headerlink" href="#retrieving-user-connection-data" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="disconnecting-entities">
+<h3>16. Disconnecting entities<a class="headerlink" href="#disconnecting-entities" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="permissions-roles">
+<h2>Permissions & Roles<a class="headerlink" href="#permissions-roles" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="assigning-permissions">
+<h3>17. Assigning permissions<a class="headerlink" href="#assigning-permissions" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="removing-permissions">
+<h3>18. Removing permissions<a class="headerlink" href="#removing-permissions" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="id1">
+<h3>19. Assigning permissions<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="id2">
+<h3>20. Removing permissions<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-roles">
+<h3>21. Creating roles<a class="headerlink" href="#creating-roles" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="assigning-roles">
+<h3>22. Assigning roles<a class="headerlink" href="#assigning-roles" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="removing-roles">
+<h3>23. Removing roles<a class="headerlink" href="#removing-roles" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="authentication">
+<h2>Authentication<a class="headerlink" href="#authentication" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="application-user-authentication-user-login">
+<h3>24. Application user authentication (user login)<a class="headerlink" href="#application-user-authentication-user-login" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="application-client-authentication">
+<h3>25. Application client authentication<a class="headerlink" href="#application-client-authentication" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="admin-user-authentication">
+<h3>26. Admin user authentication<a class="headerlink" href="#admin-user-authentication" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="organization-client-authentication">
+<h3>27. Organization client authentication<a class="headerlink" href="#organization-client-authentication" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="revoking-tokens-user-logout">
+<h3>28. Revoking tokens (user logout)<a class="headerlink" href="#revoking-tokens-user-logout" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+</div>
+<div class="section" id="working-with-users-groups">
+<h1>Working with Users & Groups<a class="headerlink" href="#working-with-users-groups" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="activities-feeds">
+<h2>Activities & Feeds<a class="headerlink" href="#activities-feeds" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="posting-a-user-activity">
+<h3>37. Posting a user activity<a class="headerlink" href="#posting-a-user-activity" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="posting-an-activity-to-a-group">
+<h3>38. Posting an activity to a group<a class="headerlink" href="#posting-an-activity-to-a-group" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-an-activity-for-a-user-s-followers-in-a-group">
+<h3>39. Creating an activity for a user’s followers in a group<a class="headerlink" href="#creating-an-activity-for-a-user-s-followers-in-a-group" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-a-user-s-activity-feed">
+<h3>40. Retrieving a user’s activity feed<a class="headerlink" href="#retrieving-a-user-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-a-group-s-activity-feed">
+<h3>41. Retrieving a group’s activity feed<a class="headerlink" href="#retrieving-a-group-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="events-counters">
+<h2>Events & Counters<a class="headerlink" href="#events-counters" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-incrementing-counters">
+<h3>42. Creating & incrementing counters<a class="headerlink" href="#creating-incrementing-counters" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-counters">
+<h3>43. Retrieving counters<a class="headerlink" href="#retrieving-counters" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-counters-by-time-interval">
+<h3>44. Retrieving counters by time interval<a class="headerlink" href="#retrieving-counters-by-time-interval" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="managing-orgs-apps">
+<h2>Managing Orgs & Apps<a class="headerlink" href="#managing-orgs-apps" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-an-organization">
+<h3>46. Creating an organization<a class="headerlink" href="#creating-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-organization">
+<h3>47. Getting an organization<a class="headerlink" href="#getting-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="activating-an-organization">
+<h3>48. Activating an organization<a class="headerlink" href="#activating-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="reactivating-an-organization">
+<h3>49. Reactivating an organization<a class="headerlink" href="#reactivating-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="generating-organization-client-credentials">
+<h3>50. Generating organization client credentials<a class="headerlink" href="#generating-organization-client-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-organization-client-credentials">
+<h3>51. Retrieving organization client credentials<a class="headerlink" href="#retrieving-organization-client-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-organization-s-activity-feed">
+<h3>52. Getting an organization’s activity feed<a class="headerlink" href="#getting-an-organization-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-the-applications-in-an-organization">
+<h3>53. Getting the applications in an organization<a class="headerlink" href="#getting-the-applications-in-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-the-admin-users-in-an-organization">
+<h3>54. Getting the admin users in an organization<a class="headerlink" href="#getting-the-admin-users-in-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="removing-an-admin-user-from-an-organization">
+<h3>55. Removing an admin user from an organization<a class="headerlink" href="#removing-an-admin-user-from-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-an-organization-application">
+<h3>56. Creating an organization application<a class="headerlink" href="#creating-an-organization-application" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="generating-application-credentials">
+<h3>57. Generating application credentials<a class="headerlink" href="#generating-application-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-application-credentials">
+<h3>58. Getting application credentials<a class="headerlink" href="#getting-application-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="managing-admin-users">
+<h2>Managing Admin Users<a class="headerlink" href="#managing-admin-users" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-an-admin-user">
+<h3>59. Creating an admin user<a class="headerlink" href="#creating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="updating-an-admin-user">
+<h3>60. Updating an admin user<a class="headerlink" href="#updating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-admin-user">
+<h3>61. Getting an admin user<a class="headerlink" href="#getting-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="setting-an-admin-user-s-password">
+<h3>62. Setting an admin user’s password<a class="headerlink" href="#setting-an-admin-user-s-password" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="resetting-an-admin-user-s-password">
+<h3>63. Resetting an admin user’s password<a class="headerlink" href="#resetting-an-admin-user-s-password" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="activating-an-admin-user">
+<h3>64. Activating an admin user<a class="headerlink" href="#activating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="reactivating-an-admin-user">
+<h3>65. Reactivating an admin user<a class="headerlink" href="#reactivating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-admin-user-s-activity-feed">
+<h3>66. Getting an admin user’s activity feed<a class="headerlink" href="#getting-an-admin-user-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/sdks/tbd.html
----------------------------------------------------------------------
diff --git a/content/docs/sdks/tbd.html b/content/docs/sdks/tbd.html
index a266bfa..7174209 100644
--- a/content/docs/sdks/tbd.html
+++ b/content/docs/sdks/tbd.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,6 +160,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/search.html
----------------------------------------------------------------------
diff --git a/content/docs/search.html b/content/docs/search.html
index bddb739..0c0687e 100644
--- a/content/docs/search.html
+++ b/content/docs/search.html
@@ -80,14 +80,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -115,6 +116,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -139,9 +141,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -156,6 +158,7 @@
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>