API docs updated (#1941)

API docs updated [ci-skip]
aws-amplify · Oct 19, 2018 · 96b7db4 · 96b7db4
1 parent 4644b43
commit 96b7db4
Show file tree

Hide file tree

Showing 153 changed files with 180,832 additions and 51,171 deletions.
diff --git a/docs/amplify-theme/typedoc/partials/header.hbs b/docs/amplify-theme/typedoc/partials/header.hbs
@@ -1,4 +1,41 @@
-
-<body>
-	{% include site-header.html %}
-</body>
+<header>	
+    <div class="tsd-page-toolbar">	
+        <div class="container">	
+            <div class="table-wrap">	
+                <div class="table-cell logo">	
+                    <a href="{{relativeURL "index.html"}}">	
+                         <img src="https://aws-amplify.github.io/images/layout/logo.png" style="width:38px; position: absolute; margin-top: 5px;">	
+                         <div style="margin-left: 45px; padding-top: 1px; position: absolute;">AWS Amplify API</div>	
+                    </a>	
+                </div>	
+                 <div class="table-cell" style="">	<body>
+                    <a href="/amplify-js/" style='background: #efefef; padding: 4px; border-radius: 20px; font-size: 14.5px; padding-left: 10px; padding-right: 10px;' for="tsd-filter-docs">AWS Amplify Home</a>
+                </div>	</body> 
+                 <div class="table-cell" id="tsd-widgets">	
+                    <div id="tsd-filter">	
+                        <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>	
+                        <div class="tsd-filter-group">	
+                            <div class="tsd-select" id="tsd-filter-visibility">	
+                                <span class="tsd-select-label">All</span>	
+                                <ul class="tsd-select-list">	
+                                    <li data-value="public">Public</li>	
+                                    <li data-value="protected">Public/Protected</li>	
+                                    <li data-value="private" class="selected">All</li>	
+                                </ul>	
+                            </div>	
+                             <input type="checkbox" id="tsd-filter-inherited" checked />	
+                            <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>	
+                             {{#unless settings.excludeExternals}}	
+                                <input type="checkbox" id="tsd-filter-externals" checked />	
+                                <label class="tsd-widget" for="tsd-filter-externals">Externals</label>	
+                            {{/unless}}	
+                             <input type="checkbox" id="tsd-filter-only-exported" />	
+                            <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>	
+                        </div>	
+                    </div>	
+                    <a href="https://aws.github.io/aws-amplify/api#typedoc-main-index" class="tsd-widget menu no-caption">Menu</a>	
+                </div>	
+            </div>	
+        </div>	
+    </div>	
+</header>
diff --git a/docs/api/assets/js/search.js b/docs/api/assets/js/search.js
diff --git a/docs/api/classes/abstractinteractionsprovider.html b/docs/api/classes/abstractinteractionsprovider.html
diff --git a/docs/api/classes/abstractpubsubprovider.html b/docs/api/classes/abstractpubsubprovider.html
diff --git a/docs/api/classes/abstractxrprovider.html b/docs/api/classes/abstractxrprovider.html
diff --git a/docs/api/classes/amplify.html b/docs/api/classes/amplify.html
diff --git a/docs/api/classes/amplifyangularmodule.html b/docs/api/classes/amplifyangularmodule.html
diff --git a/docs/api/classes/amplifyionicmodule.html b/docs/api/classes/amplifyionicmodule.html
diff --git a/docs/api/classes/amplifyservice.html b/docs/api/classes/amplifyservice.html
diff --git a/docs/api/classes/analyticsclass.html b/docs/api/classes/analyticsclass.html
diff --git a/docs/api/classes/apiclass.html b/docs/api/classes/apiclass.html
diff --git a/docs/api/classes/asyncstoragecache.html b/docs/api/classes/asyncstoragecache.html
diff --git a/docs/api/classes/authclass.html b/docs/api/classes/authclass.html
diff --git a/docs/api/classes/authenticatorcomponent.html b/docs/api/classes/authenticatorcomponent.html
diff --git a/docs/api/classes/authenticatorcomponentcore.html b/docs/api/classes/authenticatorcomponentcore.html
diff --git a/docs/api/classes/authenticatorioniccomponent.html b/docs/api/classes/authenticatorioniccomponent.html
diff --git a/docs/api/classes/awsappsyncprovider.html b/docs/api/classes/awsappsyncprovider.html
diff --git a/docs/api/classes/awscredentials.html b/docs/api/classes/awscredentials.html
diff --git a/docs/api/classes/awsiotprovider.html b/docs/api/classes/awsiotprovider.html
diff --git a/docs/api/classes/awskinesisprovider.html b/docs/api/classes/awskinesisprovider.html
diff --git a/docs/api/classes/awslexprovider.html b/docs/api/classes/awslexprovider.html
diff --git a/docs/api/classes/awspinpointprovider.html b/docs/api/classes/awspinpointprovider.html
diff --git a/docs/api/classes/browserstoragecache.html b/docs/api/classes/browserstoragecache.html
diff --git a/docs/api/classes/cachelist.html b/docs/api/classes/cachelist.html
diff --git a/docs/api/classes/cacheobject.html b/docs/api/classes/cacheobject.html
diff --git a/docs/api/classes/chatbotclass.html b/docs/api/classes/chatbotclass.html
diff --git a/docs/api/classes/chatbotcomponent.html b/docs/api/classes/chatbotcomponent.html
diff --git a/docs/api/classes/chatbotcomponentcore.html b/docs/api/classes/chatbotcomponentcore.html
diff --git a/docs/api/classes/chatbotcomponentionic.html b/docs/api/classes/chatbotcomponentionic.html
diff --git a/docs/api/classes/clientdevice.html b/docs/api/classes/clientdevice.html
diff --git a/docs/api/classes/clientsqueue.html b/docs/api/classes/clientsqueue.html
diff --git a/docs/api/classes/componentmount.html b/docs/api/classes/componentmount.html
diff --git a/docs/api/classes/confirmsigninclass.html b/docs/api/classes/confirmsigninclass.html
diff --git a/docs/api/classes/confirmsignincomponent.html b/docs/api/classes/confirmsignincomponent.html
diff --git a/docs/api/classes/confirmsignincomponentcore.html b/docs/api/classes/confirmsignincomponentcore.html
diff --git a/docs/api/classes/confirmsignincomponentionic.html b/docs/api/classes/confirmsignincomponentionic.html
diff --git a/docs/api/classes/confirmsignupclass.html b/docs/api/classes/confirmsignupclass.html
diff --git a/docs/api/classes/confirmsignupcomponent.html b/docs/api/classes/confirmsignupcomponent.html
diff --git a/docs/api/classes/confirmsignupcomponentcore.html b/docs/api/classes/confirmsignupcomponentcore.html
diff --git a/docs/api/classes/confirmsignupcomponentionic.html b/docs/api/classes/confirmsignupcomponentionic.html
diff --git a/docs/api/classes/consolelogger.html b/docs/api/classes/consolelogger.html
diff --git a/docs/api/classes/credentials.html b/docs/api/classes/credentials.html
diff --git a/docs/api/classes/doublelinkednode.html b/docs/api/classes/doublelinkednode.html
diff --git a/docs/api/classes/dynamiccomponentdirective.html b/docs/api/classes/dynamiccomponentdirective.html
diff --git a/docs/api/classes/eventtracker.html b/docs/api/classes/eventtracker.html
diff --git a/docs/api/classes/facebookoauth.html b/docs/api/classes/facebookoauth.html
diff --git a/docs/api/classes/forgotpasswordclass.html b/docs/api/classes/forgotpasswordclass.html
diff --git a/docs/api/classes/forgotpasswordcomponent.html b/docs/api/classes/forgotpasswordcomponent.html
diff --git a/docs/api/classes/forgotpasswordcomponentcore.html b/docs/api/classes/forgotpasswordcomponentcore.html
diff --git a/docs/api/classes/forgotpasswordcomponentionic.html b/docs/api/classes/forgotpasswordcomponentionic.html
diff --git a/docs/api/classes/formcomponent.html b/docs/api/classes/formcomponent.html
diff --git a/docs/api/classes/googleoauth.html b/docs/api/classes/googleoauth.html
diff --git a/docs/api/classes/greetingclass.html b/docs/api/classes/greetingclass.html
diff --git a/docs/api/classes/greetingcomponent.html b/docs/api/classes/greetingcomponent.html
diff --git a/docs/api/classes/greetingcomponentcore.html b/docs/api/classes/greetingcomponentcore.html
diff --git a/docs/api/classes/greetingcomponentionic.html b/docs/api/classes/greetingcomponentionic.html
diff --git a/docs/api/classes/hubclass.html b/docs/api/classes/hubclass.html
diff --git a/docs/api/classes/i18n.html b/docs/api/classes/i18n.html
diff --git a/docs/api/classes/i18noptions.html b/docs/api/classes/i18noptions.html
diff --git a/docs/api/classes/inmemorycache.html b/docs/api/classes/inmemorycache.html
diff --git a/docs/api/classes/interactions.html b/docs/api/classes/interactions.html
diff --git a/docs/api/classes/js.html b/docs/api/classes/js.html
diff --git a/docs/api/classes/memorystorage.html b/docs/api/classes/memorystorage.html
diff --git a/docs/api/classes/methodembed.html b/docs/api/classes/methodembed.html
diff --git a/docs/api/classes/mqttoverwsprovider.html b/docs/api/classes/mqttoverwsprovider.html
diff --git a/docs/api/classes/pageviewtracker.html b/docs/api/classes/pageviewtracker.html
diff --git a/docs/api/classes/parser.html b/docs/api/classes/parser.html
diff --git a/docs/api/classes/photopickerclass.html b/docs/api/classes/photopickerclass.html
diff --git a/docs/api/classes/photopickercomponent.html b/docs/api/classes/photopickercomponent.html
diff --git a/docs/api/classes/photopickercomponentcore.html b/docs/api/classes/photopickercomponentcore.html
diff --git a/docs/api/classes/photopickerioniccomponent.html b/docs/api/classes/photopickerioniccomponent.html
diff --git a/docs/api/classes/pubsub.html b/docs/api/classes/pubsub.html
diff --git a/docs/api/classes/pushnotification.html b/docs/api/classes/pushnotification.html
diff --git a/docs/api/classes/requirenewpasswordclass.html b/docs/api/classes/requirenewpasswordclass.html
diff --git a/docs/api/classes/requirenewpasswordcomponent.html b/docs/api/classes/requirenewpasswordcomponent.html
diff --git a/docs/api/classes/requirenewpasswordcomponentcore.html b/docs/api/classes/requirenewpasswordcomponentcore.html
diff --git a/docs/api/classes/requirenewpasswordcomponentionic.html b/docs/api/classes/requirenewpasswordcomponentionic.html
diff --git a/docs/api/classes/restclient.html b/docs/api/classes/restclient.html
diff --git a/docs/api/classes/restclientoptions.html b/docs/api/classes/restclientoptions.html
diff --git a/docs/api/classes/s3albumclass.html b/docs/api/classes/s3albumclass.html
diff --git a/docs/api/classes/s3albumcomponent.html b/docs/api/classes/s3albumcomponent.html
diff --git a/docs/api/classes/s3albumcomponentcore.html b/docs/api/classes/s3albumcomponentcore.html
diff --git a/docs/api/classes/s3albumcomponentionic.html b/docs/api/classes/s3albumcomponentionic.html
diff --git a/docs/api/classes/s3imageclass.html b/docs/api/classes/s3imageclass.html
diff --git a/docs/api/classes/s3imagecomponent.html b/docs/api/classes/s3imagecomponent.html
diff --git a/docs/api/classes/s3imagecomponentcore.html b/docs/api/classes/s3imagecomponentcore.html
diff --git a/docs/api/classes/s3imagecomponentionic.html b/docs/api/classes/s3imagecomponentionic.html
diff --git a/docs/api/classes/serviceworkerclass.html b/docs/api/classes/serviceworkerclass.html
diff --git a/docs/api/classes/sessiontracker.html b/docs/api/classes/sessiontracker.html
diff --git a/docs/api/classes/signer.html b/docs/api/classes/signer.html
diff --git a/docs/api/classes/signinclass.html b/docs/api/classes/signinclass.html
diff --git a/docs/api/classes/signincomponent.html b/docs/api/classes/signincomponent.html
diff --git a/docs/api/classes/signincomponentcore.html b/docs/api/classes/signincomponentcore.html
diff --git a/docs/api/classes/signincomponentionic.html b/docs/api/classes/signincomponentionic.html
diff --git a/docs/api/classes/signupclass.html b/docs/api/classes/signupclass.html
diff --git a/docs/api/classes/signupcomponent.html b/docs/api/classes/signupcomponent.html
diff --git a/docs/api/classes/signupcomponentcore.html b/docs/api/classes/signupcomponentcore.html
diff --git a/docs/api/classes/signupcomponentionic.html b/docs/api/classes/signupcomponentionic.html
diff --git a/docs/api/classes/storagecache.html b/docs/api/classes/storagecache.html
diff --git a/docs/api/classes/storageclass.html b/docs/api/classes/storageclass.html
diff --git a/docs/api/classes/storagehelper.html b/docs/api/classes/storagehelper.html
diff --git a/docs/api/classes/sumerianprovider.html b/docs/api/classes/sumerianprovider.html
diff --git a/docs/api/classes/xr.html b/docs/api/classes/xr.html
diff --git a/docs/api/classes/xrerror.html b/docs/api/classes/xrerror.html
diff --git a/docs/api/classes/xrnodomelement.html b/docs/api/classes/xrnodomelement.html
diff --git a/docs/api/classes/xrnosceneconfigurederror.html b/docs/api/classes/xrnosceneconfigurederror.html
diff --git a/docs/api/classes/xrprovidernotconfigured.html b/docs/api/classes/xrprovidernotconfigured.html
diff --git a/docs/api/classes/xrsceneloadfailure.html b/docs/api/classes/xrsceneloadfailure.html
diff --git a/docs/api/classes/xrscenenotfounderror.html b/docs/api/classes/xrscenenotfounderror.html
diff --git a/docs/api/classes/xrscenenotloadederror.html b/docs/api/classes/xrscenenotloadederror.html
diff --git a/docs/api/globals.html b/docs/api/globals.html
diff --git a/docs/api/index.html b/docs/api/index.html
diff --git a/docs/api/interfaces/amplifyconfig.html b/docs/api/interfaces/amplifyconfig.html
diff --git a/docs/api/interfaces/analyticsoptions.html b/docs/api/interfaces/analyticsoptions.html
diff --git a/docs/api/interfaces/analyticsprovider.html b/docs/api/interfaces/analyticsprovider.html
diff --git a/docs/api/interfaces/apioptions.html b/docs/api/interfaces/apioptions.html
diff --git a/docs/api/interfaces/authcache.html b/docs/api/interfaces/authcache.html
diff --git a/docs/api/interfaces/authoptions.html b/docs/api/interfaces/authoptions.html
diff --git a/docs/api/interfaces/authstate.html b/docs/api/interfaces/authstate.html
diff --git a/docs/api/interfaces/cacheconfig.html b/docs/api/interfaces/cacheconfig.html
diff --git a/docs/api/interfaces/cacheitem.html b/docs/api/interfaces/cacheitem.html
diff --git a/docs/api/interfaces/cacheitemoptions.html b/docs/api/interfaces/cacheitemoptions.html
diff --git a/docs/api/interfaces/confirmsignupoptions.html b/docs/api/interfaces/confirmsignupoptions.html
diff --git a/docs/api/interfaces/eventattributes.html b/docs/api/interfaces/eventattributes.html
diff --git a/docs/api/interfaces/eventmetrics.html b/docs/api/interfaces/eventmetrics.html
diff --git a/docs/api/interfaces/eventtrackopts.html b/docs/api/interfaces/eventtrackopts.html
diff --git a/docs/api/interfaces/federatedresponse.html b/docs/api/interfaces/federatedresponse.html
diff --git a/docs/api/interfaces/federateduser.html b/docs/api/interfaces/federateduser.html
diff --git a/docs/api/interfaces/graphqloptions.html b/docs/api/interfaces/graphqloptions.html
diff --git a/docs/api/interfaces/graphqlresult.html b/docs/api/interfaces/graphqlresult.html
diff --git a/docs/api/interfaces/icache.html b/docs/api/interfaces/icache.html
diff --git a/docs/api/interfaces/icredentials.html b/docs/api/interfaces/icredentials.html
diff --git a/docs/api/interfaces/interactionsoptions.html b/docs/api/interfaces/interactionsoptions.html
diff --git a/docs/api/interfaces/interactionsprovider.html b/docs/api/interfaces/interactionsprovider.html
diff --git a/docs/api/interfaces/interactionsproviders.html b/docs/api/interfaces/interactionsproviders.html
diff --git a/docs/api/interfaces/interactionsresponse.html b/docs/api/interfaces/interactionsresponse.html
diff --git a/docs/api/interfaces/logger.html b/docs/api/interfaces/logger.html
diff --git a/docs/api/interfaces/mfarequireddetails.html b/docs/api/interfaces/mfarequireddetails.html
diff --git a/docs/api/interfaces/mqttprovidertoptions.html b/docs/api/interfaces/mqttprovidertoptions.html
diff --git a/docs/api/interfaces/oauth.html b/docs/api/interfaces/oauth.html
diff --git a/docs/api/interfaces/pageviewtrackopts.html b/docs/api/interfaces/pageviewtrackopts.html
diff --git a/docs/api/interfaces/provideroptions.html b/docs/api/interfaces/provideroptions.html
diff --git a/docs/api/interfaces/providertoptions.html b/docs/api/interfaces/providertoptions.html
diff --git a/docs/api/interfaces/pubsuboptions.html b/docs/api/interfaces/pubsuboptions.html
diff --git a/docs/api/interfaces/pubsubprovider.html b/docs/api/interfaces/pubsubprovider.html
diff --git a/docs/api/interfaces/sceneoptions.html b/docs/api/interfaces/sceneoptions.html
diff --git a/docs/api/interfaces/sessiontrackopts.html b/docs/api/interfaces/sessiontrackopts.html
diff --git a/docs/api/interfaces/signoutopts.html b/docs/api/interfaces/signoutopts.html
diff --git a/docs/api/interfaces/signupparams.html b/docs/api/interfaces/signupparams.html
diff --git a/docs/api/interfaces/storageoptions.html b/docs/api/interfaces/storageoptions.html
diff --git a/docs/api/interfaces/xroptions.html b/docs/api/interfaces/xroptions.html
diff --git a/docs/api/interfaces/xrprovider.html b/docs/api/interfaces/xrprovider.html
diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
     "cypress": "lerna exec yarn cypress",
     "cypress:open": "lerna exec yarn cypress:open",
     "coverage": "codecov || exit 0",
-    "docs": "typedoc packages/**/src --name amplify-js --hideGenerator --excludePrivate --ignoreCompilerErrors --mode file --out docs/api",
+    "docs": "typedoc packages/**/src --name amplify-js --hideGenerator --excludePrivate --ignoreCompilerErrors --mode file --out docs/api --theme docs/amplify-theme/typedoc/",
     "build": "lerna exec yarn build",
     "clean": "lerna run -- clean",
     "format": "lerna run -- format",