Added Configure to SDK documentation
This commit is contained in:
@@ -56,6 +56,12 @@
|
||||
|
||||
<p>Userbase is accessible directly from the browser through a very simple JavaScript SDK. The following is the complete set of APIs that let you create user accounts, handle logins, and persist user data.</p>
|
||||
|
||||
<h3 id="sdk-configure">Configure</h3>
|
||||
<p>Use this API to configure your Userbase client.</p>
|
||||
<ul>
|
||||
<li><a href="/docs/sdk/configure" class="font-semibold">Configure</a></li>
|
||||
</ul>
|
||||
|
||||
<h3 id="sdk-users">Users</h3>
|
||||
<p>Use these APIs to create user accounts, handle logins and logouts, and resume sessions when a user returns to your web app.</p>
|
||||
<ul>
|
||||
|
||||
31
src/pages/docs_sdk_configure.html
Normal file
31
src/pages/docs_sdk_configure.html
Normal file
@@ -0,0 +1,31 @@
|
||||
<div class="section">
|
||||
<h2><a href="/docs/#sdk">SDK</a> : Configure</h2>
|
||||
|
||||
<p><span class="font-semibold">Configure</span> lets you configure your Userbase client.</p>
|
||||
|
||||
<pre>
|
||||
<code class="language-javascript">userbase.configure({ appId, endpoint })</code>
|
||||
</pre>
|
||||
|
||||
<h3 id="params">Parameters</h3>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<span class="field">settings</span> [object] - Contains your configuration settings.
|
||||
<ul>
|
||||
<li><span class="field">appId</span> [string] - Your App ID you received when you created a Userbase application.</li>
|
||||
<li><span class="field">endpoint</span> [string] - If you're hosting your own Userbase server, you can provide its endpoint here.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="errors">Errors</h3>
|
||||
|
||||
<ul>
|
||||
<li>ConfigParametersMissing</li>
|
||||
<li>UserAlreadySignedIn</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<hr>
|
||||
Reference in New Issue
Block a user